version 8.3: reviewable steps #2718

pepopowitz · 2023-10-09T19:49:34Z

Description

Part of #2432. Blocks #2717.

This PR includes the smaller changes for cutting versions 8.3/3.11.0, so that they can be reviewed by a human.

Once this is merged into its target branch, #2717 can be reviewed & merged!

When should this change go live?

This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
There is no urgency with this change.
This change or page is part of a marketing blog, conference talk, or something else on a schedule.
This functionality is already available but undocumented.
This is a bug fix or security concern.

PR Checklist

I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

… Optimize 3.11

pepopowitz · 2023-10-09T19:55:24Z

docusaurus.config.js

+          "3.10.0": {
+            banner: "none",
+          },


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

pepopowitz · 2023-10-09T19:55:29Z

docusaurus.config.js

+          "3.11.0": {
+            label: "8.3 / 3.11.0",
+          },


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:

pepopowitz · 2023-10-09T19:56:15Z

docusaurus.config.js

+          // surprising, yes, but true: 3.8 should show unsupported banner, but 3.7 should not.
+          "3.7.0": {
            banner: "none",
          },


3.7.0 remains supported, as discussed in Slack.

pepopowitz · 2023-10-09T19:57:01Z

docusaurus.config.js

              banner: "none",
            },
-            "8.0": {
+            8.1: {
              banner: "none",
            },
          },


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

pepopowitz · 2023-10-09T19:57:13Z

docusaurus.config.js

+            "/docs/8.2/**",
            "/optimize/3.7.0/**",
            "/optimize/3.8.0/**",
            "/optimize/3.9.0/**",
+            "/optimize/3.10.0/**",


We only want the most recent docs in our sitemap.

pepopowitz · 2023-10-09T19:57:51Z

hacks/cutNewVersions.sh

+NEW_DOCS_VERSION="8.3"
+PREVIOUS_DOCS_VERSION="8.2"
+NEW_OPTIMIZE_VERSION="3.11.0"
+PREVIOUS_OPTIMIZE_VERSION="3.10.0"


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.

pepopowitz · 2023-10-09T19:58:40Z

optimize_versioned_sidebars/version-3.10.0-sidebars.json

Older version sidebars went from using versionless URLs to specifying their version.

pepopowitz · 2023-10-09T19:59:51Z

static/.htaccess

+# 8.2 content moves: These were removed from latest version docs, so point them back to previous version for now. 
+#   Remove them in the not-distant future.
+RewriteRule ^docs/guides/update-guide/026-to-100/?$ /docs/8.2/guides/update-guide/026-to-100/ [R=301,L]
+RewriteRule ^docs/guides/update-guide/100-to-110/?$ /docs/8.2/guides/update-guide/100-to-110/ [R=301,L]
+RewriteRule ^docs/guides/update-guide/110-to-120/?$ /docs/8.2/guides/update-guide/110-to-120/ [R=301,L]
+RewriteRule ^docs/guides/update-guide/120-to-130/?$ /docs/8.2/guides/update-guide/120-to-130/ [R=301,L]
+
+# 8.3 content moves
+RewriteRule ^docs/guides/update-guide/connectors/(.*)$ /docs/components/connectors/custom-built-connectors/update-guide/$1 [R=301,L]
+RewriteRule ^docs/guides/update-guide/(.*)$ /docs/self-managed/operational-guides/update-guide/$1 [R=301,L]
+RewriteRule ^docs/self-managed/backup-restore/(.*)$ /docs/self-managed/operational-guides/backup-restore/$1 [R=301,L]
+RewriteRule ^docs/self-managed/troubleshooting/log-levels/(.*)$ /docs/self-managed/operational-guides/troubleshooting/log-levels$1 [R=301,L]


I've been advocating for us to not maintain rewrite rules for "next" docs lately, but here I see the down-side -- I had to identify all these pages that moved in the next version, and add redirects for them.

I don't think this is wrong or a reason for us to maintain redirect rules for next docs...it is just noteworthy.

…e resolved

christinaausley

WAHOOOOOO! Ship it 🚢

pepopowitz · 2023-10-09T20:22:37Z

src/mdx/expandVersionedUrl.js

+  {
+    docsVersion: "8.3",
+    optimizeVersion: "3.11.0",
+  },


oops! I forgot this, and it caused a bunch of broken links in the build

For future reference, if the build says this:

- On source page path = /optimize/self-managed/optimize-deployment/version-policy/: -> linking to $docs$/reference/release-policy/ (resolved as: /optimize/self-managed/optimize-deployment/version-policy/$docs$/reference/release-policy/)

...it means the version it's building isn't defined in this array, so it doesn't know what to resolve $docs$ or $optimize$ to. (Note the $docs$ in the broken link)

* version: new versions of docs * version 8.3: reviewable steps (#2718) * chore: update cutNewVersions with new version numbers * version: sidebars * version: version manifests * version: redirects * chore: show/hide correct version banners, and customize the label for Optimize 3.11 * chore: redirects for content that moved between 8.2 and 8.3 * oops: swap the version numbers for 8.3 label * fix: map new versions to each other so cross-instance shortcuts can be resolved

pepopowitz added 6 commits October 9, 2023 14:34

chore: update cutNewVersions with new version numbers

648634b

version: sidebars

b3161aa

version: version manifests

5a79ab1

version: redirects

f954426

chore: show/hide correct version banners, and customize the label for…

b1c815f

… Optimize 3.11

chore: redirects for content that moved between 8.2 and 8.3

2bc1f68

pepopowitz self-assigned this Oct 9, 2023

oops: swap the version numbers for 8.3 label

c95a770

pepopowitz commented Oct 9, 2023

View reviewed changes

pepopowitz requested review from akeller and christinaausley October 9, 2023 20:00

pepopowitz added kind/feature Issues related with features to be documented dx Documentation infrastructure typically handled by the Camunda DX team labels Oct 9, 2023

fix: map new versions to each other so cross-instance shortcuts can b…

dd288b7

…e resolved

christinaausley approved these changes Oct 9, 2023

View reviewed changes

pepopowitz commented Oct 9, 2023

View reviewed changes

pepopowitz merged commit 9c036e9 into pepopowitz/cut-8-3 Oct 9, 2023
4 checks passed

pepopowitz deleted the pepopowitz/cut-8-3-reviewable branch October 9, 2023 20:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

version 8.3: reviewable steps #2718

version 8.3: reviewable steps #2718

pepopowitz commented Oct 9, 2023 •

edited

Loading

pepopowitz Oct 9, 2023

pepopowitz Oct 9, 2023

pepopowitz Oct 9, 2023

pepopowitz Oct 9, 2023

pepopowitz Oct 9, 2023

pepopowitz Oct 9, 2023

pepopowitz Oct 9, 2023

pepopowitz Oct 9, 2023

christinaausley left a comment

pepopowitz Oct 9, 2023 •

edited

Loading

version 8.3: reviewable steps #2718

version 8.3: reviewable steps #2718

Conversation

pepopowitz commented Oct 9, 2023 • edited Loading

Description

When should this change go live?

PR Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

christinaausley left a comment

Choose a reason for hiding this comment

pepopowitz Oct 9, 2023 • edited Loading

Choose a reason for hiding this comment

pepopowitz commented Oct 9, 2023 •

edited

Loading

pepopowitz Oct 9, 2023 •

edited

Loading