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

Remove next documents in favor of two releases at a time. #344

Merged
merged 1 commit into from
Jun 25, 2024

Conversation

TerryHowe
Copy link
Member

@TerryHowe TerryHowe commented Jun 7, 2024

Maintaining 3 copies of the documents will be very difficult making sure fixes happen for each version. This PR reduces the number to 2. We can use the latest release at the basis for the next new release.

@TerryHowe TerryHowe changed the title No next Remove next dcouments in favor of two releases at a time. Jun 7, 2024
Copy link
Member

@asmitbm asmitbm left a comment

Choose a reason for hiding this comment

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

I'm not sure if Docusaurus recommends removing the main docs from the /docs folder. Instead, we can rename the Next docs to match the current version we're working on and keep the last version.

@TerryHowe
Copy link
Member Author

It seems to work fine from the preview.

@asmitbm
Copy link
Member

asmitbm commented Jun 9, 2024

It seems to work fine from the preview.

Yes, it does, but when we need to create new versioned docs, we'll need the source docs located in the /docs folder.

Ref: https://docusaurus.io/docs/versioning#tagging-a-new-version

@TerryHowe
Copy link
Member Author

That is really just a process.

I'm not opposed to having docs be latest i.e 1.2 right now, but I'd like to have no more than 2 copies of the docs normally.

@qweeah
Copy link
Contributor

qweeah commented Jun 11, 2024

LGTM although IANAM

IMHO, it's better to use a dedicated branch to track the doc of next version.

Signed-off-by: Terry Howe <terrylhowe@gmail.com>
@TerryHowe
Copy link
Member Author

Based on the discussion in the meeting this week, people are in favor of having all the docs in the versioned_docs directory so it is clear what they are. People are also in favor of the 2 versions max idea. The site works fine without a docs directory.

@TerryHowe TerryHowe changed the title Remove next dcouments in favor of two releases at a time. Remove next documents in favor of two releases at a time. Jun 17, 2024
Copy link
Member

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

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

LGTM. It avoids ambiguity to just keep the versioned doc folder per our discussion in the meeting.

@TerryHowe TerryHowe merged commit 5d2cbe2 into oras-project:main Jun 25, 2024
6 checks passed
TerryHowe pushed a commit to TerryHowe/oras-www that referenced this pull request Jul 21, 2024
…ct#344)

Maintaining 3 copies of the documents will be very difficult making sure
fixes happen for each version. This PR reduces the number to 2. We can
use the latest release at the basis for the next new release.

Signed-off-by: Terry Howe <terrylhowe@gmail.com>
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.

4 participants