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

* archiving: delete version version-0.26 * archiving: delete version version-1.0 * archiving: delete version version-1.1 * archiving: delete version version-1.2 * archiving: delete version version-1.3 * archiving: delete version version-8.0 * archiving: delete version version-8.1 * archiving: delete version version-8.2 * archiving: delete version version-8.2 * archiving: exclude all other versions from the version file * archiving: prevent unsupported site from being crawled * archiving: fix Dockerfile for local debugging * archiving: update docusaurus config to build only 0.25 * archiving: update theme components * archiving(CI): remove link-checking from build-docs workflow * archiving(CI): remove link-check workflow * archiving(links): update or remove broken links * archiving(ci): remove the rest of the link-checking from build docs because it will take some effort to get docker running correctly, and I think we just don't care about unsupported versions. * archiving(config): use an icon that stands out in announcement bar * archiving(ci): update publish workflows to push to the right place * archiving(ci): run publish workflows at the correct time * archiving(ci): fix trigger for prod publish * archiving(htaccess): update rewrite rules based on URL structure of isolated 0.25 site * archiving(oops): put the tags-ignore back in, to prevent staging deploy when a release is tagged
camunda · Jun 5, 2023 · 7fab275 · 7fab275
1 parent df3ade0
commit 7fab275
Show file tree

Hide file tree

Showing 10 changed files with 134 additions and 735 deletions.
diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml
@@ -30,32 +30,3 @@ jobs:
         run: npm run build
         env:
           NODE_OPTIONS: --max_old_space_size=4096
-      - name: Remove https redirect
-        run: |
-          sed -i '/SERVER_PORT/d;/SERVER_NAME/d' build/.htaccess
-      - name: Run web server
-        run: |
-          docker run -d --name webserver -v "$PWD/build":/app -p 8888:8080 bitnami/apache:2.4.54
-          echo "container_ip=$(docker inspect -f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' webserver)" >> $GITHUB_ENV
-      - name: Download sitemap from production
-        run: curl -sL https://docs.camunda.io/sitemap.xml | grep -oP '<loc>\K.*?(?=</loc>)' | sed "s!https://docs.camunda.io!http://${{ env.container_ip }}:8080!g" > sitemap.prod.txt
-      - name: Prepare product links
-        run: grep 'https://docs.camunda.io' product-links.txt | sed "s!https://docs.camunda.io!http://${{ env.container_ip }}:8080!g" > product-links.prod.txt
-      - name: Waiting for URL available
-        uses: nev7n/wait_for_response@v1
-        with:
-          url: "http://${{ env.container_ip }}:8080/"
-      - name: Validate sitemap links
-        uses: lycheeverse/lychee-action@v1.6.1
-        with:
-          args: "sitemap.prod.txt"
-          fail: true
-      - name: Validate product links
-        uses: lycheeverse/lychee-action@v1.6.1
-        with:
-          args: "product-links.prod.txt"
-          fail: true
-      - name: Check internal links
-        uses: untitaker/hyperlink@0.1.27
-        with:
-          args: build/
diff --git a/.github/workflows/linkcheck.yaml b/.github/workflows/linkcheck.yaml
diff --git a/.github/workflows/publish-prod.yaml b/.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]+"
 
 permissions:
   id-token: write
@@ -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
           remote_host: ${{ secrets.AWS_PROD_PUBLISH_HOST }}
           remote_user: ${{ secrets.AWS_PROD_PUBLISH_USER }}
           # vvvvv Intentionally missing the AWS_ prefix vvvvv

diff --git a/.github/workflows/publish-stage.yaml b/.github/workflows/publish-stage.yaml
@@ -3,7 +3,7 @@ name: publish-stage
 on:
   push:
     branches:
-      - "main"
+      - "unsupported/0.25"
     tags-ignore:
       - "*"
 
@@ -20,10 +20,8 @@ jobs:
           node-version: 16
       - name: Install Dependencies
         run: npm ci
-      - name: Disable Indexing
-        run: "sed -i 's/noIndex: false/noIndex: true/g' docusaurus.config.js"
       - 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'
       - name: Build
         run: npm run build
         env:
@@ -43,7 +41,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
           remote_host: ${{ secrets.AWS_STAGE_PUBLISH_HOST }}
           remote_user: ${{ secrets.AWS_STAGE_PUBLISH_USER }}
           # vvvvv Intentionally missing the AWS_ prefix vvvvv

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -1,12 +1,10 @@
-const versionedLinks = require("./src/mdx/versionedLinks");
-
 module.exports = {
   title: "Camunda Platform 8 Docs",
   tagline: "Documentation for all components of Camunda Platform 8",
   // url: "https://camunda-cloud.github.io",
-  url: "https://docs.camunda.io",
+  url: "https://unsupported.docs.camunda.io",
   // baseUrl: "/camunda-cloud-documentation/",
-  baseUrl: "/",
+  baseUrl: "/0.25/",
   onBrokenLinks: "throw",
   onBrokenMarkdownLinks: "throw",
   favicon: "img/favicon.ico",
@@ -34,35 +32,16 @@ module.exports = {
       },
     ],
     "./static/plugins/bpmn-js",
-    [
-      "@docusaurus/plugin-content-docs",
-      {
-        id: "optimize",
-        path: "optimize",
-        routeBasePath: "optimize",
-        beforeDefaultRemarkPlugins: [versionedLinks],
-        sidebarPath: require.resolve("./optimize_sidebars.js"),
-        editUrl: "https://github.com/camunda/camunda-platform-docs/edit/main/",
-        versions: {
-          "3.9.0": {
-            banner: "none",
-          },
-          "3.8.0": {
-            banner: "none",
-          },
-        },
-      },
-    ],
   ],
   scripts: [],
   themeConfig: {
     announcementBar: {
       id: "camunda8",
       content:
-        '📣 <b><a target="_blank" rel="noopener noreferrer" href="https://signup.camunda.com/accounts?utm_source=docs.camunda.io&utm_medium=referral&utm_content=banner">Sign-Up</a></b> for a free account to start orchestrating business processes today.',
-      backgroundColor: "#14D890",
-      textColor: "#000",
-      isCloseable: true,
+        '🚨 This version of Camunda Platform 8 is no longer actively maintained. For up-to-date documentation, see <b><a target="_blank" rel="noopener noreferrer" href="https://docs.camunda.io">the latest version</a></b>.',
+      backgroundColor: "#FFC600",
+      textColor: "#434343",
+      isCloseable: false,
     },
     prism: {
       additionalLanguages: ["java", "protobuf"],
@@ -75,7 +54,7 @@ module.exports = {
       },
       items: [
         {
-          type: "docsVersionDropdown",
+          type: "docsVersion",
           position: "left",
         },
         {
@@ -90,18 +69,6 @@ module.exports = {
           label: "Components",
           position: "left",
         },
-        {
-          type: "doc",
-          docId: "apis-tools/working-with-apis-tools",
-          label: "APIs & Tools",
-          position: "left",
-        },
-        {
-          type: "doc",
-          docId: "self-managed/about-self-managed",
-          label: "Self-Managed",
-          position: "left",
-        },
         {
           type: "doc",
           docId: "reference/overview",
@@ -127,7 +94,7 @@ module.exports = {
             },
             {
               label: "Try free",
-              href: "https://signup.camunda.com/accounts?utm_source=docs.camunda.io&utm_medium=referral&utm_content=footer",
+              href: "https://signup.camunda.com/accounts?utm_source=unsupported.docs.camunda.io&utm_medium=referral&utm_content=footer",
             },
             {
               label: "Contact",
@@ -185,7 +152,7 @@ module.exports = {
             },
             {
               label: "Release cycle",
-              to: "docs/reference/release-policy",
+              to: "https://docs.camunda.io/docs/reference/release-policy",
             },
           ],
         },
@@ -201,11 +168,11 @@ module.exports = {
             },
             {
               label: "Licenses",
-              to: "docs/reference/licenses",
+              to: "https://docs.camunda.io/docs/reference/licenses",
             },
             {
               label: "Security notices",
-              to: "docs/reference/notices",
+              to: "https://docs.camunda.io/docs/reference/notices",
             },
           ],
         },
@@ -224,18 +191,14 @@ module.exports = {
       "@docusaurus/preset-classic",
       {
         docs: {
-          sidebarPath: require.resolve("./sidebars.js"),
-          // Please change this to your repo.
-          editUrl:
-            "https://github.com/camunda/camunda-platform-docs/edit/main/",
-          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.
+          lastVersion: "0.25",
+          includeCurrentVersion: false,
           versions: {
-            8.1: {
-              banner: "none",
-            },
-            "8.0": {
-              banner: "none",
+            0.25: {
+              label: "0.25",
+              path: "/",
+              noIndex: true,
+              banner: "unmaintained",
             },
           },
         },
@@ -244,24 +207,8 @@ module.exports = {
           customCss: require.resolve("./src/css/custom.css"),
         },
         sitemap: {
-          changefreq: "weekly",
-          priority: 0.5,
-          ignorePatterns: [
-            "/docs/**/tags/**",
-            "/docs/next/**",
-            "/docs/0.25/**",
-            "/docs/0.26/**",
-            "/docs/1.0/**",
-            "/docs/1.1/**",
-            "/docs/1.2/**",
-            "/docs/1.3/**",
-            "/docs/8.0/**",
-            "/docs/8.1/**",
-            "/optimize/3.7.0/**",
-            "/optimize/3.8.0/**",
-            "/optimize/3.9.0/**",
-            "/optimize/next/**",
-          ],
+          // exclude everything from sitemap
+          ignorePatterns: ["**"],
         },
       },
     ],

diff --git a/src/pages/contact.md b/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.
 
 - **Feedback and Support** can be submitted or requested via JIRA for subscription or enterprise customers in the Support project. Otherwise, use the [Camunda Platform community forum](https://forum.camunda.io/). For more information about Enterprise support and additional support resources please see [Enterprise Support](https://camunda.com/support/).
 

diff --git a/src/pages/index.js b/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/",
     description: <>Programmatically interact with your automated processes.</>,
   },
 ];
@@ -41,7 +41,7 @@ const features2 = [
   {
     title: "Self-Managed",
     imageUrl: "img/self-managed.png",
-    url: "/docs/self-managed/about-self-managed/",
+    url: "/",
     description: (
       <>
         A self-hosted Camunda Platform 8 alternative, offering everything you
@@ -164,41 +164,6 @@ function Home() {
             </div>
           </section>
         )}
-        <div className={clsx("hero hero--secondary", styles.heroBanner)}>
-          <div className="container">
-            <h2 className="hero__title">Unsure where to begin?</h2>
-            <p className="hero__subtitle">Try one of our use case guides</p>
-            <div className={styles.buttons}>
-              <Link
-                className={clsx(
-                  "button button--outline button--secondary button--lg button--hero get-started-use-case",
-                  styles.getStarted
-                )}
-                to={useBaseUrl("docs/guides/orchestrate-microservices/")}
-              >
-                Microservice Orchestration
-              </Link>
-              <Link
-                className={clsx(
-                  "button button--outline button--secondary button--lg button--hero get-started-use-case get-started-use-case-2",
-                  styles.getStarted
-                )}
-                to={useBaseUrl("docs/guides/orchestrate-human-tasks/")}
-              >
-                Human Task Orchestration
-              </Link>
-              <Link
-                className={clsx(
-                  "button button--outline button--secondary button--lg button--hero get-started-use-case get-started-use-case-2",
-                  styles.getStarted
-                )}
-                to={useBaseUrl("docs/guides/orchestrate-api-endpoints/")}
-              >
-                API Endpoint Orchestration
-              </Link>
-            </div>
-          </div>
-        </div>
       </main>
     </Layout>
   );

diff --git a/src/theme/AnnouncementBar/index.js b/src/theme/AnnouncementBar/index.js