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

chore: move next version into versioned_docs folder #338

Closed
wants to merge 13 commits into from

Conversation

qweeah
Copy link
Contributor

@qweeah qweeah commented Jun 6, 2024

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:

> tree
.
├── docs                       <--- docs of next version
├── versioned_docs
│   ├── version-1.1            <--- docs of version v1.1.0
│   └── version-1.2            <--- docs of version v1.2.0
...

Folder structure after the change:

> tree
.
├── versioned_docs
│   ├── static
│   ├── version-1.1            <--- docs of version v1.1.0
│   ├── version-1.2            <--- docs of version v1.2.0
│   └── version-next           <--- docs of next version
...

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.

@qweeah qweeah changed the title chore: move next version docs into version_docs chore: move next version into versioned_docs folder Jun 6, 2024
@qweeah qweeah closed this Jun 6, 2024
@qweeah qweeah reopened this Jun 6, 2024
@qweeah
Copy link
Contributor Author

qweeah commented Jun 6, 2024

Seems that how documentations in docs are not referencing static folder in a unified way, that's why I need to copy static folder to both versioned_docs and version-next at the same time.

@qweeah qweeah marked this pull request as ready for review June 6, 2024 08:29
@FeynmanZhou
Copy link
Member

@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/
image

@TerryHowe
Copy link
Member

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?

@qweeah
Copy link
Contributor Author

qweeah commented Jun 7, 2024

@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/ image

@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.

@qweeah
Copy link
Contributor Author

qweeah commented Jun 7, 2024

Can we just create the next release off the latest when we get a release candidate?

The jumbled reference comes from community folder, which should not belong to any release but it's currently put into the next release docs.

@qweeah qweeah force-pushed the test-doc branch 2 times, most recently from 58e1f7f to ce65754 Compare June 7, 2024 03:07
qweeah added 12 commits June 7, 2024 07:47
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <[emaijinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <[emaijinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <[emaijinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <[emaijinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <[emaijinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <[emaijinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <[emaijinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <[emaijinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <[emaijinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <[emaijinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <[emaijinzha1@microsoft.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Signed-off-by: Billy Zha <[emaijinzha1@microsoft.com>
Signed-off-by: Billy Zha <[emaijinzha1@microsoft.com>
@qweeah
Copy link
Contributor Author

qweeah commented Jun 11, 2024

closing as #344 is a better option.

@qweeah qweeah closed this Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants