diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml
index 14669d0b0f..181c23c96c 100644
--- 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 '\K.*?(?=)' | 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
deleted file mode 100644
index 5384bde3b8..0000000000
--- a/.github/workflows/linkcheck.yaml
+++ /dev/null
@@ -1,28 +0,0 @@
-name: Check Links
-
-on:
- workflow_dispatch:
- schedule:
- - cron: "0 22 * * *"
-
-jobs:
- linkChecker:
- name: Check links for url ${{ matrix.url }}
- runs-on: ubuntu-latest
- strategy:
- matrix:
- url: ["https://docs.camunda.io", "https://stage.docs.camunda.io"]
- steps:
- - uses: actions/checkout@v2
- - name: Download sitemap from production
- run: curl -sL https://docs.camunda.io/sitemap.xml | grep -oP '\K.*?(?=)' | sed "s!https://docs.camunda.io!${{ matrix.url }}!g" > sitemap.prod.txt
- - name: Prepare product links
- run: grep 'https://docs.camunda.io' product-links.txt | sed "s!https://docs.camunda.io!${{ matrix.url }}!g" > product-links.prod.txt
- - name: Check internal links
- uses: filiph/linkcheck@2.0.23
- with:
- arguments: "--connection-failures-as-warnings -i sitemap.prod.txt"
- - name: Check product links
- uses: filiph/linkcheck@2.0.23
- with:
- arguments: "--connection-failures-as-warnings -i product-links.prod.txt"
diff --git a/.github/workflows/publish-prod.yaml b/.github/workflows/publish-prod.yaml
index 098500e4ac..fd8b920c45 100644
--- 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
index 53b0fb564f..69b37e2deb 100644
--- 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
index 675060e740..8112e67831 100644
--- 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:
- '📣 Sign-Up 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 the latest version.',
+ 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
index 8852e6a9a9..1e7f2bab3d 100644
--- 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
index 4442ab60ff..4f9d0ba4c8 100644
--- 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() {
)}
-
-
-
Unsure where to begin?
-
Try one of our use case guides
-
-
- Microservice Orchestration
-
-
- Human Task Orchestration
-
-
- API Endpoint Orchestration
-
-
-
-
);
diff --git a/src/theme/AnnouncementBar/index.js b/src/theme/AnnouncementBar/index.js
deleted file mode 100644
index dd42ce1927..0000000000
--- a/src/theme/AnnouncementBar/index.js
+++ /dev/null
@@ -1,52 +0,0 @@
-import React from "react";
-import AnnouncementBar from "@theme-original/AnnouncementBar";
-
-import { Auth0Provider, useAuth0 } from "@auth0/auth0-react";
-import BrowserOnly from "@docusaurus/BrowserOnly";
-
-export default function AnnouncementBarWrapper(props) {
- return (
- <>
-
-
- );
-}
-
-const AnnouncementBarWithAuth = (props) => {
- return (
-
- {() => {
- const auth0Config = {
- domain: "weblogin.cloud.camunda.io",
- clientId: "xxpG51I1fjAVqkyiclS3IFntj9pC46lA",
- audience: "cloud.camunda.io",
- origin: window.location.origin,
- };
- return (
-
-
-
- );
- }}
-
- );
-};
-
-const AnnouncementBarIfAuthenticated = (props) => {
- return (
-
- {() => {
- const { isAuthenticated } = useAuth0();
- if (isAuthenticated) {
- return ;
- }
- return ;
- }}
-
- );
-};
diff --git a/src/theme/DocVersionBanner/index.js b/src/theme/DocVersionBanner/index.js
new file mode 100644
index 0000000000..ff78c42837
--- /dev/null
+++ b/src/theme/DocVersionBanner/index.js
@@ -0,0 +1,101 @@
+// Why is this swizzled?
+// To override the message displayed by `LatestVersionSuggestionLabel`. The built-in version
+// of this component can only link to another internal version, and the message includes a version
+// defined in this app. In an archived version of our documentation, neither of those pre-requisites are met.
+// In the `main` branch of these docs, this component exists in an `archive/` folder, so that it is
+// ignored by docusaurus. In an archived branch of these docs, the component is moved outside of the `archive/`
+// folder, so that it is recognized by docusaurus.
+// This is a very simplified version of the built-in DocVersionBanner file, not intended to support
+// all use cases. It's only intended to meet the needs of an archived version of the docs.
+// Swizzled from version 2.3.1.
+
+import React from "react";
+import clsx from "clsx";
+import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
+import Link from "@docusaurus/Link";
+import Translate from "@docusaurus/Translate";
+import { ThemeClassNames } from "@docusaurus/theme-common";
+import { useDocsVersion } from "@docusaurus/theme-common/internal";
+
+function UnmaintainedVersionLabel({ siteTitle, versionMetadata }) {
+ return (
+ {versionMetadata.label},
+ }}
+ >
+ {
+ "This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained."
+ }
+
+ );
+}
+
+function BannerLabel(props) {
+ return ;
+}
+
+function LatestVersionSuggestionLabel({ versionLabel }) {
+ return (
+
+
+
+ latest version
+
+
+
+ ),
+ }}
+ >
+ {"For up-to-date documentation, see the {latestVersionLink}."}
+
+ );
+}
+
+function DocVersionBannerEnabled({ className, versionMetadata }) {
+ const {
+ siteConfig: { title: siteTitle },
+ } = useDocusaurusContext();
+ return (
+