feat: cut 8.0 version (and default to it); expose "next" version #1118
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses #1115
What
This PR:
The vast majority of changes in this PR are to cut the 8.0 version -- this process clones the entire set of docs into a new versioned folder. The only exception is visible in 6772e2b -- it configures docusaurus to use a
Nextversion, and default to8.0as the current version.Why
This gives us the ability to iterate on docs for upcoming releases and content restructuring efforts. Rather than being forced to do them in a long-lived branch, we can do them in main, as part of the “next” version.
More specifically, it sets us up to iterate toward giving the Optimize documentation its own set of versions, as described in #1116.
How does this impact users?
8.0selected in the version selector, instead oflatest. This will remain the default version when they come to docs.camunda.io.Nextversion, which they hadn't been able to do before.What does it look like?
Default version
By default, browsing to
docs.camunda.iowill serve the user the8.0docs. The URLs will look the same as they currently do for thelatestversion in production -- absent of a version (e.g./docs/guides/). Because of this, we do not need to add any redirect rules.The docs they're viewing for 8.0 will be sourced from the
/versioned_docs/version-8.0source folder.NextversionIf the user selects
Nextfrom the version dropdown, they'll browse the next set of docs. Their URL will include the/next/version. The docs they're viewing will be sourced from the/docssource folder.How does this impact content authors?
/versioned_docs/version-8.0source folder, instead of/docs/docssource folder. These updates can be merged whenever, rather than waiting for the 8.1 release to take place.When will this be merged?
Because of the impact of this PR, especially on existing PRs, I don't intend to merge this immediately. I will be following up with all currently open PRs to develop a plan for minimizing merge headaches. If all goes well, early next week (August 8th) I intend to:
Background
This work is in preparation of giving the Optimize documentation its own set of versions. It is the implementation of Recommendation #2 described in the Optimize Multi-Instance Documentation Proposal.