chore: archival of version 0.25, part 3: manual steps #2167

pepopowitz · 2023-06-02T21:08:25Z

Description

Part of #1173. Follows #2166.

More steps to isolate a site for version 0.25, including:

Not included in this PR, but coming in follow-ups

I forgot to remove all the optimize folders! That will create another large PR, so not including it here.

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.

…ecause it will take some effort to get docker running correctly, and I think we just don't care about unsupported versions.

pepopowitz · 2023-06-02T21:38:44Z

.github/workflows/build-docs.yaml

-      - name: Check internal links
-        uses: untitaker/hyperlink@0.1.27
-        with:
-          args: build/


This is potentially controversial. The sitemap & product link checks are definitely not something we want to run, because this is an isolated site containing only one old version. But the internal links of the app is probably still worth checking, if it's not much work.

Unfortunately it isn't "not much work"! I'd have to alter the steps above that run the webserver to run the app in a /0.25 folder, or else the internal link-checking would fail because of the baseURL of /0.25.

My feeling is that it's fine to remove this link-checking. It's an unsupported version of the docs, and if an internal link gets broken over time, I think we just say forget it.

But if you feel strongly that I should get this internal link-checking working, let me know!!!

pepopowitz · 2023-06-02T22:04:49Z

.github/workflows/linkcheck.yaml

Removing this workflow entirely, as we won't want to run it against the 0.25 site.

pepopowitz · 2023-06-02T22:07:56Z

.github/workflows/publish-prod.yaml

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


I think this is the right way to do this? Trigger a 0.25 production build only when we create a 0.25.X release.

🚨 We'll have to make sure we update main to exclude the archived tags before we publish a 0.25.x release! Otherwise I think main will trigger a new prod publish, and deploy the 0.25 site to docs.camunda.io!!! (I think that's what would happen?)

PR to prevent accidental 0.25 deployment to docs.camunda.io is up, at #2172

pepopowitz · 2023-06-02T22:08:42Z

.github/workflows/publish-prod.yaml

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


I've already added this new key to the project secrets (and to the Keeper record that contains these secrets).

pepopowitz · 2023-06-02T22:10:31Z

.github/workflows/publish-stage.yaml

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


I've already added this new key to the project secrets (and to the Keeper record that contains these secrets).

.github/workflows/publish-stage.yaml

pepopowitz · 2023-06-02T22:13:31Z

docusaurus.config.js

@@ -185,7 +152,7 @@ module.exports = {
            },
            {
              label: "Release cycle",
-              to: "docs/reference/release-policy",
+              to: "https://docs.camunda.io/docs/reference/release-policy",


These are footer links. A few of these pages don't exist in the 0.25 site, so I pointed them at production instead.

pepopowitz · 2023-06-02T22:14:00Z

src/pages/contact.md

@@ -11,7 +11,7 @@ There are various channels where you can reach us.

 - We welcome your **bug** reports and **feature requests** through our community channels mentioned above.

- For **security-related issues**, review our [Security notices](../docs/reference/notices) for the most up-to-date information on known issues and steps to report a vulnerability so we can solve the problem as quickly as possible. Do not use GitHub for security-related issues.
+- For **security-related issues**, review our [Security notices](https://docs.camunda.io/docs/reference/notices) for the most up-to-date information on known issues and steps to report a vulnerability so we can solve the problem as quickly as possible. Do not use GitHub for security-related issues.


No page here in 0.25! It feels better to send them somewhere, since it's security stuff.

pepopowitz · 2023-06-02T22:14:18Z

src/pages/index.js

@@ -32,7 +32,7 @@ const features = [
  {
    title: "APIs & Tools",
    imageUrl: "img/apisclients.png",
-    url: "/docs/apis-tools/working-with-apis-tools/",
+    url: "/docs/components/clients/build-your-own-client/",


These are the homepage features. This URL translates pretty well.

pepopowitz · 2023-06-02T22:14:59Z

src/pages/index.js

@@ -41,7 +41,7 @@ const features2 = [
  {
    title: "Self-Managed",
    imageUrl: "img/self-managed.png",
-    url: "/docs/self-managed/about-self-managed/",
+    url: "/",


This URL has nothing related in 0.25! Instead of removing the entire feature block, because that makes it look funny, I left it in and pointed it at the home page. It's "unsupported" so that's safe????

pepopowitz · 2023-06-02T22:15:36Z

src/pages/index.js

@@ -164,41 +164,6 @@ function Home() {
            </div>
          </section>
        )}
-        <div className={clsx("hero hero--secondary", styles.heroBanner)}>


None of these three buttons have a 0.25 page! (Technically one of them does but it just says "TODO"!)

So I removed this whole green block.

…solated 0.25 site

pepopowitz · 2023-06-05T15:59:12Z

static/.htaccess

The only rules remaining are specific to 0.25, and they've been updated so that the left side does not include 0.25 (because the app itself won't receive the 0.25 part of the URL), and the right side does include 0.25 (because otherwise it will redirect outside of the 0.25 app).

…e-0.25-part-3-manual

…oy when a release is tagged

pepopowitz added 16 commits June 2, 2023 14:58

archiving: delete version version-0.26

ea8618a

archiving: delete version version-1.0

442d458

archiving: delete version version-1.1

30026c6

archiving: delete version version-1.2

2f6a4c7

archiving: delete version version-1.3

3c4019c

archiving: delete version version-8.0

fb1dbb8

archiving: delete version version-8.1

a9a5c2f

archiving: delete version version-8.2

00423cd

archiving: delete version version-8.2

a8b3adf

archiving: exclude all other versions from the version file

587045a

archiving: prevent unsupported site from being crawled

d28b398

archiving: fix Dockerfile for local debugging

38ab421

archiving: update docusaurus config to build only 0.25

8abd64f

archiving: update theme components

bfb4071

archiving(CI): remove link-checking from build-docs workflow

caf1152

archiving(CI): remove link-check workflow

5a991ee

pepopowitz self-assigned this Jun 2, 2023

pepopowitz marked this pull request as draft June 2, 2023 21:08

pepopowitz added dx Documentation infrastructure typically handled by the Camunda DX team epic:archive-old-versions labels Jun 2, 2023

pepopowitz mentioned this pull request Jun 2, 2023

(WIP) chore: archival of version 0.25, part 3: manual steps #2164

Closed

9 tasks

pepopowitz added 2 commits June 2, 2023 16:26

archiving(links): update or remove broken links

9eacbb9

archiving(ci): remove the rest of the link-checking from build docs b…

9d35da5

…ecause it will take some effort to get docker running correctly, and I think we just don't care about unsupported versions.

pepopowitz commented Jun 2, 2023

View reviewed changes

pepopowitz added 4 commits June 2, 2023 16:40

archiving(config): use an icon that stands out in announcement bar

8b1b224

archiving(ci): update publish workflows to push to the right place

ebc5bfd

archiving(ci): run publish workflows at the correct time

a466c4e

archiving(ci): fix trigger for prod publish

3daaf78

pepopowitz commented Jun 2, 2023

View reviewed changes

archiving(htaccess): update rewrite rules based on URL structure of i…

9f3cba2

…solated 0.25 site

pepopowitz requested a review from akeller June 5, 2023 15:56

pepopowitz marked this pull request as ready for review June 5, 2023 15:56

pepopowitz commented Jun 5, 2023

View reviewed changes

Base automatically changed from pepopowitz/1173-archiving/isolate-0.25-part-2-automated to unsupported/0.25 June 5, 2023 18:06

pepopowitz and others added 2 commits June 5, 2023 13:07

Merge branch 'unsupported/0.25' into pepopowitz/1173-archiving/isolat…

3024f8e

…e-0.25-part-3-manual

archiving(oops): put the tags-ignore back in, to prevent staging depl…

cb854ab

…oy when a release is tagged

pepopowitz merged commit 7fab275 into unsupported/0.25 Jun 5, 2023

pepopowitz deleted the pepopowitz/1173-archiving/isolate-0.25-part-3-manual branch June 5, 2023 18:26

This was referenced Jun 12, 2023

feat: add an archival script for updating theme components #2230

Merged

chore: isolation of version 0.26, part 3: manual steps #2235

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: archival of version 0.25, part 3: manual steps #2167

chore: archival of version 0.25, part 3: manual steps #2167

pepopowitz commented Jun 2, 2023 •

edited

Loading

pepopowitz Jun 2, 2023

pepopowitz Jun 2, 2023

pepopowitz Jun 2, 2023

pepopowitz Jun 5, 2023

pepopowitz Jun 2, 2023

pepopowitz Jun 2, 2023

pepopowitz Jun 2, 2023

pepopowitz Jun 2, 2023

pepopowitz Jun 2, 2023

pepopowitz Jun 2, 2023

pepopowitz Jun 2, 2023

pepopowitz Jun 5, 2023

chore: archival of version 0.25, part 3: manual steps #2167

chore: archival of version 0.25, part 3: manual steps #2167

Conversation

pepopowitz commented Jun 2, 2023 • edited Loading

Description

Not included in this PR, but coming in follow-ups

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

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

pepopowitz commented Jun 2, 2023 •

edited

Loading