archive(8.1) isolation: automated steps #3755

pepopowitz · 2024-05-01T21:29:37Z

Description

Part of #3731.

Note: this PR will be merged into the unsupported/8.1 branch. It will never make it into main.

Note: this PR will not go green. There are manual cleanup steps coming in a future PR that will make this branch green.

Continues the process of archival/isolation for version 8.1. Includes the following steps, which a computer did for me:

Exclude all other versions from version manifest files
Prevent the 8.1 site from being crawled
Fix the Dockerfile for local debugging
Update the swizzled theme components for the isolated version.
Update CI workflows.
Update the docusaurus.config.js.
Configure the 3.9.0 optimize docs instance

See #2796 for a similar PR in a previous archived version, if that's helpful for comparison purposes during review.

Description

When should this change go live?

This is a bug fix, security concern, or something that needs urgent release support.
This is already available but undocumented and should be released within a week.
This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
There is no urgency with this change and can be released at any time.
My goal is to complete archival of 8.1 by the end of this week (May 3). I'd like to merge this in the next day to meet this schedule.

PR Checklist

My changes are for an already released minor and are in /versioned_docs directory.
My changes are for the next minor and are in /docs directory (aka /next/).

My changes require an Engineering review, and I've assigned the Engineerring DRI or delegate.
My changes require a technical writer review, and I've assigned @christinaausley as a reviewer.

…file

akeller · 2024-05-01T21:45:31Z

I was second-guessing my approval because the build process was also modified in the linked reference PR, but I don't think that's necessary here. Can you confirm?

pepopowitz

@akeller I commented inline with all the reasons that the deployment workflows are modified. Let me know if any of it doesn't make sense!

pepopowitz · 2024-05-02T14:28:45Z

.github/workflows/publish-prod.yaml

@@ -3,14 +3,7 @@ name: publish-prod
 on:
  push:
    tags:
-      - "[0-9]+.[0-9]+.[0-9]+"


publish-prod is modified so that it only runs for 8.1.x tags. This branch, unsupported/8.1, will only contain the 8.1 site. We want to be able to deploy it to production, which we will continue to be able to do by adding new 8.1.x tags.

pepopowitz · 2024-05-02T14:29:08Z

.github/workflows/publish-prod.yaml

@@ -46,7 +39,7 @@ jobs:
        with:
          switches: -avzr --delete
          path: build/
-          remote_path: ${{ secrets.AWS_PROD_PUBLISH_PATH }}


this drops it in the unsupported.docs.camunda.io domain instead of docs.camunda.io.

pepopowitz · 2024-05-02T14:29:49Z

.github/workflows/publish-stage.yaml

@@ -3,7 +3,7 @@ name: publish-stage
 on:
  push:
    branches:
-      - "main"


This branch is going to be deployed to stage.unsupported.docs.camunda.io/8.1, and we only want to deploy this branch.

pepopowitz · 2024-05-02T14:30:35Z

.github/workflows/publish-stage.yaml

@@ -21,7 +21,7 @@ jobs:
      - name: Install Dependencies
        run: npm ci
      - name: Update URL
-        run: 'sed -i ''s!url: "https://docs.camunda.io"!url: "https://stage.docs.camunda.io"!g'' docusaurus.config.js'
+        run: 'sed -i ''s!url: "https://unsupported.docs.camunda.io"!url: "https://stage.unsupported.docs.camunda.io"!g'' docusaurus.config.js'


The docusaurus config contains references to the unsupported URL, so this step needs to account for that.

pepopowitz · 2024-05-02T14:31:10Z

.github/workflows/publish-stage.yaml

@@ -43,7 +43,7 @@ jobs:
        with:
          switches: -avzr --delete
          path: build/
-          remote_path: ${{ secrets.AWS_STAGE_PUBLISH_PATH }}
+          remote_path: ${{ secrets.AWS_STAGE_PUBLISH_PATH_UNSUPPORTED }}/8.1


staging site for this branch is deployed to stage.unsupported.docs.camunda.io/8.1.

pepopowitz · 2024-05-02T14:32:04Z

Dockerfile

@@ -3,12 +3,12 @@
 FROM httpd:alpine

 RUN rm -r /usr/local/apache2/htdocs/*
-COPY /build /usr/local/apache2/htdocs/
+COPY /build /usr/local/apache2/htdocs/8.1/


This Dockerfile is for local development. Running the site within an 8.1 folder allows us to not have to make changes to the docusaurus configuration, which is expecting the site to be deployed within an 8.1 folder.

pepopowitz · 2024-05-02T14:58:43Z

As discussed over Slack, the issue is not the deployment workflows, but build-docs.yaml is missing a bunch of changes that were done in the previous archival.

This happened because the script to delete all that stuff is looking for the line to build the docs, which specifies the heap size.......which we updated recently, thus causing the script to not find what it was looking for.

Updating & adding that removal to this PR!

pepopowitz · 2024-05-02T16:14:41Z

As discussed over Slack, the issue is not the deployment workflows, but build-docs.yaml is missing a bunch of changes that were done in the previous archival.

This happened because the script to delete all that stuff is looking for the line to build the docs, which specifies the heap size.......which we updated recently, thus causing the script to not find what it was looking for.

Updating & adding that removal to this PR!

build-docs workflow is fixed in latest commit.

I'll update the associated script in a separate PR, so that it can target main.

akeller · 2024-05-02T16:30:17Z

Odd that it didn't prompt me to approve again, but you are good to merge when ready!

pepopowitz · 2024-05-02T18:59:05Z

Odd that it didn't prompt me to approve again, but you are good to merge when ready!

Maybe GitHub doesn't care as much because it's not merging into main?

pepopowitz added 7 commits May 1, 2024 16:24

archiving(8.1): exclude all other versions from the main version file

8b7704b

archiving(8.1): exclude all other versions from the optimize version …

4cc9ea3

…file

archiving(8.1): prevent unsupported site from being crawled

e396daf

archiving(8.1): fix Dockerfile for local debugging

60a5b67

archiving(8.1): update theme components

6f952ab

archiving(8.1): update CI workflows

345258c

archiving(8.1): update docusaurus config

c265242

pepopowitz self-assigned this May 1, 2024

archiving(8.1): configure Optimize docs instance

ff23e39

pepopowitz force-pushed the pepopowitz/3731-81-archival/2-automated-steps branch from 79d71a5 to ff23e39 Compare May 1, 2024 21:32

pepopowitz requested a review from akeller May 1, 2024 21:35

pepopowitz added kind/cleanup Issues related with clean-up the documentation dx Documentation infrastructure typically handled by the Camunda DX team labels May 1, 2024

pepopowitz mentioned this pull request May 1, 2024

Archive 8.1/3.9.0 #3731

Closed

akeller approved these changes May 1, 2024

View reviewed changes

pepopowitz commented May 2, 2024

View reviewed changes

archive(8.1): update build-docs

68cc535

pepopowitz mentioned this pull request May 2, 2024

fix: update archival scripts #3759

Merged

9 tasks

pepopowitz merged commit cdfd542 into unsupported/8.1 May 2, 2024
5 of 6 checks passed

pepopowitz deleted the pepopowitz/3731-81-archival/2-automated-steps branch May 2, 2024 18:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

archive(8.1) isolation: automated steps #3755

archive(8.1) isolation: automated steps #3755

pepopowitz commented May 1, 2024 •

edited

akeller commented May 1, 2024

pepopowitz left a comment

pepopowitz May 2, 2024

pepopowitz May 2, 2024

pepopowitz May 2, 2024

pepopowitz May 2, 2024

pepopowitz May 2, 2024

pepopowitz May 2, 2024

pepopowitz commented May 2, 2024

pepopowitz commented May 2, 2024

akeller commented May 2, 2024

pepopowitz commented May 2, 2024

archive(8.1) isolation: automated steps #3755

archive(8.1) isolation: automated steps #3755

Conversation

pepopowitz commented May 1, 2024 • edited

Description

Description

When should this change go live?

PR Checklist

akeller commented May 1, 2024

pepopowitz left a comment

Choose a reason for hiding this comment

pepopowitz May 2, 2024

Choose a reason for hiding this comment

pepopowitz May 2, 2024

Choose a reason for hiding this comment

pepopowitz May 2, 2024

Choose a reason for hiding this comment

pepopowitz May 2, 2024

Choose a reason for hiding this comment

pepopowitz May 2, 2024

Choose a reason for hiding this comment

pepopowitz May 2, 2024

Choose a reason for hiding this comment

pepopowitz commented May 2, 2024

pepopowitz commented May 2, 2024

akeller commented May 2, 2024

pepopowitz commented May 2, 2024

pepopowitz commented May 1, 2024 •

edited