apolloconfig/apollo

feature request: document support multiple version

Open

#4327 opened on Apr 27, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (29,769 stars) (10,177 forks)batch import
area/documentfeature requesthelp wanted

Description

Is your feature request related to a problem? Please describe. When user view the document https://www.apolloconfig.com/ , user may be only care about the document match their apollo's version.

For example, when user user's apollo version is 1.5.0, he/she may be confuse when see the feature above 1.5.0

Describe the solution you'd like When someone use elasticsearch, its official site https://www.elastic.co/guide/en/elasticsearch/reference/7.17/index.html support choose the matched version of document. image

Maybe we can add a button version on the top right of site? image and jump to that version's document which mark by the git tag.

Additional context It's will improve the experience about the document, decrease the user's confuse.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
The Apollo documentation site is likely built from the repository's docs folder. Investigate the current site generation tool and theme. Consider implementing a version switcher similar to Elasticsearch's documentation, which allows users to select a version. The switcher should map to git tags for each version. Review existing documentation structure and propose a solution that integrates with the build process.