-
Notifications
You must be signed in to change notification settings - Fork 189
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: archival of version 0.25, part 3: manual steps #2167
Changes from all commits
ea8618a
442d458
30026c6
2f6a4c7
3c4019c
fb1dbb8
a9a5c2f
00423cd
a8b3adf
587045a
d28b398
38ab421
8abd64f
bfb4071
caf1152
5a991ee
9eacbb9
9d35da5
8b1b224
ebc5bfd
a466c4e
3daaf78
9f3cba2
3024f8e
cb854ab
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,7 +3,7 @@ name: publish-prod | |
on: | ||
push: | ||
tags: | ||
- "[0-9]+.[0-9]+.[0-9]+" | ||
- "0.25.[0-9]+" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. PR to prevent accidental 0.25 deployment to docs.camunda.io is up, at #2172 |
||
|
||
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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've already added this new key to the project secrets (and to the Keeper record that contains these secrets). |
||
remote_host: ${{ secrets.AWS_PROD_PUBLISH_HOST }} | ||
remote_user: ${{ secrets.AWS_PROD_PUBLISH_USER }} | ||
# vvvvv Intentionally missing the AWS_ prefix vvvvv | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,7 +3,7 @@ name: publish-stage | |
on: | ||
push: | ||
branches: | ||
- "main" | ||
- "unsupported/0.25" | ||
pepopowitz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
tags-ignore: | ||
- "*" | ||
|
||
|
@@ -20,10 +20,8 @@ jobs: | |
node-version: 16 | ||
- name: Install Dependencies | ||
run: npm ci | ||
- name: Disable Indexing | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Indexing is already disabled in the config itself. |
||
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' | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. New URLs |
||
- 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've already added this new key to the project secrets (and to the Keeper record that contains these secrets). |
||
remote_host: ${{ secrets.AWS_STAGE_PUBLISH_HOST }} | ||
remote_user: ${{ secrets.AWS_STAGE_PUBLISH_USER }} | ||
# vvvvv Intentionally missing the AWS_ prefix vvvvv | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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", | ||
[ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No optimize docs for this version. |
||
"@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", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These are footer links. A few of these pages don't exist in the 0.25 site, so I pointed them at production instead. |
||
}, | ||
], | ||
}, | ||
|
@@ -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: ["**"], | ||
}, | ||
}, | ||
], | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No page here in 0.25! It feels better to send them somewhere, since it's security stuff. |
||
|
||
- **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/). | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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/", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These are the homepage features. This URL translates pretty well. |
||
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: "/", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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???? |
||
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)}> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. |
||
<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> | ||
); | ||
|
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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!!!