apolloconfig/apollo

feature request: document support multiple version

Open

#4,327 建立於 2022年4月27日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Java (29,769 star) (10,177 fork)batch import
area/documentfeature requesthelp wanted

描述

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.

貢獻者指南

技術棧
無
領域
documentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
35
研究方向
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.