apolloconfig/apollo

feature request: document support multiple version

Open

Aperta il 27 apr 2022

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Java (29.769 star) (10.177 fork)batch import
area/documentfeature requesthelp wanted

Descrizione

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.

Guida contributor

Tech stack
Nessuno
Dominio
documentation
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 days
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
35
Direzione di ricerca
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.