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.

Sign up for GitHub

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

version 8.3: reviewable steps #2718

Merged
merged 8 commits into from
Oct 9, 2023
Merged

version 8.3: reviewable steps #2718

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
648634b
chore: update cutNewVersions with new version numbers
pepopowitz Oct 9, 2023
b3161aa
version: sidebars
pepopowitz Oct 9, 2023
5a79ab1
version: version manifests
pepopowitz Oct 9, 2023
f954426
version: redirects
pepopowitz Oct 9, 2023
b1c815f
chore: show/hide correct version banners, and customize the label for…
pepopowitz Oct 9, 2023
2bc1f68
chore: redirects for content that moved between 8.2 and 8.3
pepopowitz Oct 9, 2023
c95a770
oops: swap the version numbers for 8.3 label
pepopowitz Oct 9, 2023
dd288b7
fix: map new versions to each other so cross-instance shortcuts can b…
pepopowitz Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,17 @@ module.exports = {
sidebarPath: require.resolve("./optimize_sidebars.js"),
editUrl: "https://github.com/camunda/camunda-docs/edit/main/",
versions: {
"3.11.0": {
label: "8.3 / 3.11.0",
},
Comment on lines +50 to +52
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This label has most recently been discussed in Slack.

Note that this label only applies to Optimize documentation.

This is what it looks like when viewing an Optimize page:

image

"3.10.0": {
banner: "none",
},
Comment on lines +53 to +55
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This prevents docusaurus from showing an "version is unsupported" banner, because we support previous versions for 18 months.

"3.9.0": {
banner: "none",
},
"3.8.0": {
// surprising, yes, but true: 3.8 should show unsupported banner, but 3.7 should not.
"3.7.0": {
banner: "none",
},
Comment on lines +59 to 62
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

3.7.0 remains supported, as discussed in Slack.

},
Expand Down Expand Up @@ -239,10 +246,10 @@ module.exports = {
beforeDefaultRemarkPlugins: [versionedLinks],
// 👋 When cutting a new version, remove the banner for maintained versions by adding an entry. Remove the entry to versions >18 months old.
versions: {
8.1: {
8.2: {
banner: "none",
},
"8.0": {
8.1: {
banner: "none",
},
},
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

These versions just rotate. 8.0 becomes unsupported, 8.2 is configured to not show the "unsupported" banner.

Expand All @@ -261,9 +268,11 @@ module.exports = {
"/docs/1.3/**",
"/docs/8.0/**",
"/docs/8.1/**",
"/docs/8.2/**",
"/optimize/3.7.0/**",
"/optimize/3.8.0/**",
"/optimize/3.9.0/**",
"/optimize/3.10.0/**",
Comment on lines +271 to +275
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We only want the most recent docs in our sitemap.

"/optimize/next/**",
],
},
Expand Down
8 changes: 4 additions & 4 deletions hacks/cutNewVersions.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
set -e

# Before running this script make sure these versions are correct!
NEW_DOCS_VERSION="8.2"
PREVIOUS_DOCS_VERSION="8.1"
NEW_OPTIMIZE_VERSION="3.10.0"
PREVIOUS_OPTIMIZE_VERSION="3.9.0"
NEW_DOCS_VERSION="8.3"
PREVIOUS_DOCS_VERSION="8.2"
NEW_OPTIMIZE_VERSION="3.11.0"
PREVIOUS_OPTIMIZE_VERSION="3.10.0"
Comment on lines +5 to +8
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

These versions are only used for the tooling that cuts a version, but it's nice to commit them so that it's easier to figure out how it works at time of next release.


echo "1/5 Creating version $NEW_DOCS_VERSION of main docs..."
npm run docusaurus docs:version $NEW_DOCS_VERSION
Expand Down
Loading
Loading