Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature:document support multiple version #4452

Closed
wants to merge 11 commits into from

Conversation

falser101
Copy link
Member

What's the purpose of this PR

document support multiple version

Which issue(s) this PR fixes:

Fixes #4327

@falser101 falser101 changed the title Feature/document feature:document support multiple version Jul 8, 2022
@codecov-commenter
Copy link

codecov-commenter commented Jul 8, 2022

Codecov Report

Merging #4452 (ab064a3) into master (3440475) will increase coverage by 0.03%.
The diff coverage is n/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%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3440475...ab064a3. Read the comment docs.

Signed-off-by: jianfei.zhang <[email protected]>
@falser101
Copy link
Member Author

What kind of version style do you want?
@nobodyiam

@nobodyiam
Copy link
Member

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.

@falser101
Copy link
Member Author

falser101 commented Jul 11, 2022

Maybe we need to create version folder in docs and to put different versions of the files in the corresponding version folder.
@nobodyiam

@nobodyiam
Copy link
Member

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?

@falser101
Copy link
Member Author

@Anilople

@Anilople
Copy link
Contributor

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.

@nobodyiam
Copy link
Member

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.

@falser101
Copy link
Member Author

falser101 commented Jul 19, 2022

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

@nobodyiam
Copy link
Member

There is a proposal in docsify that apollo uses to render the sites: docsifyjs/docsify#1289.
However, there doesn't seem to be any progress...

@falser101 falser101 closed this Aug 21, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Aug 21, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feature request: document support multiple version
4 participants