-
Notifications
You must be signed in to change notification settings - Fork 64
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
chore: move next version into versioned_docs folder #338
Conversation
Seems that how documentations in docs are not referencing |
@qweeah After moving the static folder, the icons svg seems not available on the preview link: https://deploy-preview-338--oras-project.netlify.app/docs/1.2/ |
Since we don't build an artifact for each commit on main, I was wondering if we should have a next at all. The more copies, the more changes we are going to lose between releases. Can we just create the next release off the latest when we get a release candidate? |
@FeynmanZhou It's true, the icons are missing but I checked other PR's preview deployment (e.g. https://deploy-preview-340--oras-project.netlify.app/) and all those icons are missing. I think it's a bug in the netlify preview environment. |
The jumbled reference comes from community folder, which should not belong to any release but it's currently put into the next release docs. |
58e1f7f
to
ce65754
Compare
Signed-off-by: Billy Zha <[email protected]> Signed-off-by: Billy Zha <[[email protected]>
Signed-off-by: Billy Zha <[email protected]> Signed-off-by: Billy Zha <[[email protected]>
Signed-off-by: Billy Zha <[email protected]> Signed-off-by: Billy Zha <[[email protected]>
Signed-off-by: Billy Zha <[email protected]> Signed-off-by: Billy Zha <[[email protected]>
Signed-off-by: Billy Zha <[email protected]> Signed-off-by: Billy Zha <[[email protected]>
Signed-off-by: Billy Zha <[email protected]> Signed-off-by: Billy Zha <[[email protected]>
Signed-off-by: Billy Zha <[email protected]> Signed-off-by: Billy Zha <[[email protected]>
Signed-off-by: Billy Zha <[email protected]> Signed-off-by: Billy Zha <[[email protected]>
Signed-off-by: Billy Zha <[email protected]> Signed-off-by: Billy Zha <[[email protected]>
Signed-off-by: Billy Zha <[email protected]> Signed-off-by: Billy Zha <[[email protected]>
Signed-off-by: Billy Zha <[email protected]> Signed-off-by: Billy Zha <[[email protected]>
Signed-off-by: Billy Zha <[email protected]> Signed-off-by: Billy Zha <[[email protected]>
Signed-off-by: Billy Zha <[[email protected]>
closing as #344 is a better option. |
What is done
All docs about next version of ORAS, as well as the community docs are moved from
./docs
to./versioned_docs/version-next
Folder structure before the change:
Folder structure after the change:
Why it's needed
After merging of #316, when I start to work on #324, I am totally lost on which file should I modify so that only documents regarding v1.2.0 can be changed. To align the folder structure and avoid such confusion, it's better to place all the documents into
versioned-docs
with dedicated folder for each version.