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

feat: add version control to documentation #316

Merged
merged 3 commits into from
Jun 5, 2024

Conversation

FeynmanZhou
Copy link
Member

@FeynmanZhou FeynmanZhou commented May 23, 2024

Resolve #317. Add version control to ORAS documentation. ORAS users will be able to choose a version from the drop-down list.

v1.2.0 is the default version. Next is the upcoming version which is in development.

image

@FeynmanZhou FeynmanZhou changed the title chore: add version control to documentation feat: add version control to documentation May 23, 2024
shizhMSFT
shizhMSFT previously approved these changes May 24, 2024
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@TerryHowe
Copy link
Member

All the links in the footer link to unversion pages and seem to be broken

@TerryHowe
Copy link
Member

I don't see links to the community pages in the preview

Signed-off-by: Feynman Zhou <[email protected]>
@FeynmanZhou
Copy link
Member Author

I don't see links to the community pages in the preview

Details

@TerryHowe I temporarily hide the doc links within footer section in this PR. I may need more time to investigate and will resolve it in the next PR.

@FeynmanZhou
Copy link
Member Author

I don't see links to the community pages in the preview

@TerryHowe
Do you expect that the Community pages should be existed in the current release (v1.2.0) only?
image

@TerryHowe
Copy link
Member

All the links in the footer are missing or broken now

@TerryHowe
Copy link
Member

I spent an hour messing with this and haven't improved anything although I suspect something around https://docusaurus.io/docs/versioning#navbar-items would fix the links. I was mostly trying to understand how to have versioned and unversioned chunks of documents, but that isn't working either

@FeynmanZhou
Copy link
Member Author

I spent an hour messing with this and haven't improved anything although I suspect something around https://docusaurus.io/docs/versioning#navbar-items would fix the links. I was mostly trying to understand how to have versioned and unversioned chunks of documents, but that isn't working either

@TerryHowe
Thanks for your investigation.
I also looked into the doc but has not found a solution https://docusaurus.io/docs/versioning#navbar-items.
So I temporarily hide the doc links within footer section. I also moved the Community page from "Next" to the current version "v1.2.0".

I may need more time to investigate the versioned link route and will resolve it in the next PR.

Copy link
Member

@TerryHowe TerryHowe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@TerryHowe TerryHowe merged commit 7fc53b2 into oras-project:main Jun 5, 2024
6 checks passed
TerryHowe pushed a commit to TerryHowe/oras-www that referenced this pull request Jul 21, 2024
Resolve oras-project#317. Add version
control to ORAS documentation. ORAS users will be able to choose a
version from the drop-down list.

v1.2.0 is the default version. `Next` is the upcoming version which is
in development.


![image](https://github.com/oras-project/oras-www/assets/40452856/b9de5563-c4ac-416e-bf99-cfe8cbf3f313)

---------

Signed-off-by: Feynman Zhou <[email protected]>
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.

Support version control
3 participants