feature:document support multiple version
What's the purpose of this PR
document support multiple version
Which issue(s) this PR fixes:
Fixes #4327
Codecov Report
Merging #4452 (ab064a3) into master (3440475) will increase coverage by
0.03%. The diff coverage isn/a.
@@ Coverage Diff @@
## master #4452 +/- ##
============================================
+ Coverage 53.54% 53.57% +0.03%
Complexity 2692 2692
============================================
Files 488 488
Lines 15229 15229
Branches 1587 1587
============================================
+ Hits 8154 8159 +5
+ Misses 6518 6514 -4
+ Partials 557 556 -1
| Impacted Files | Coverage Δ | |
|---|---|---|
| ...mework/apollo/portal/component/PortalSettings.java | 65.62% <0.00%> (+7.81%) |
:arrow_up: |
Continue to review full report at Codecov.
Legend - Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing dataPowered by Codecov. Last update 3440475...ab064a3. Read the comment docs.
What kind of version style do you want? @nobodyiam
Currently, apolloconfig.com refers to the latest version of the docs folder. By supporting multiple versions of documentation, users could switch to different versions of the docs folder, e.g. when user chooses 1.9.2, then it should refer to the 1.9.2 tag. I'm not sure how that could be achieved, but it should behave like this way.
Maybe we need to create version folder in docs and to put different versions of the files in the corresponding version folder. @nobodyiam
Maybe we need to create version folder in docs and to put different versions of the files in the corresponding version folder. @nobodyiam
Currently, this seems the way to go. @Anilople do you have any suggestions?
@Anilople
Maybe we need to create version folder in docs and to put different versions of the files in the corresponding version folder. @nobodyiam
Currently, this seems the way to go. @Anilople do you have any suggestions?
That will consume large cost to maintain it.
Reference to different tag seems better.
Can we combine them together? i.e generate the version folder during CI rather than commit them to the git repo directly.
generate the version folder during CI rather than commit them to the git repo directly.
It will be best to do so during CI as this is the most consistent way. If we can't do so during CI, then we need to add a step to copy the docs to a version folder when releasing a new version.
It will be best to do so during CI as this is the most consistent way. If we can't do so during CI, then we need to add a step to copy the docs to a version folder when releasing a new version.
What should I do if we generate the version folder during CI? i don't kown how to do that @nobodyiam @Anilople
There is a proposal in docsify that apollo uses to render the sites: https://github.com/docsifyjs/docsify/issues/1289. However, there doesn't seem to be any progress...