Skip to content
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

d3: reintroduce 8.5 docs #4872

Conversation

pepopowitz
Copy link
Collaborator

@pepopowitz pepopowitz commented Jan 17, 2025

Description

Part of #4799.

Reintroduces 8.5 documentation, by adding it back into the version manifests.

If all goes well, I will also include 8.5 API re-generation in this PR.

I'm not sure if the build for this one will be green or red, let's find out together.

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)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

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/).

@pepopowitz pepopowitz self-assigned this Jan 17, 2025
@pepopowitz pepopowitz added dx Documentation infrastructure typically handled by the Camunda DX team epic:docusaurus3 kind/cleanup Issues related with clean-up the documentation labels Jan 17, 2025
Copy link
Contributor

github-actions bot commented Jan 17, 2025

👋 🤖 🤔 Hello, @pepopowitz! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.

  • docs/apis-tools/camunda-api-rest/specifications/add-user-to-group.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/assign-group-to-tenant.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/assign-mapping-rule-to-tenant.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/assign-user-task.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/assign-user-to-tenant.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/cancel-process-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/complete-user-task.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-authorization.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-deployment.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-document-link.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-document.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-documents.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-element-instance-variables.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-process-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-tenant.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/delete-group.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/delete-mapping-rule.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/delete-resource.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/delete-role.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/delete-tenant.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/evaluate-decision.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/fail-job.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-authorizations.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-decision-definitions.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-decision-instances.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-decision-requirements.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-flow-node-instances.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-incidents.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-mappings.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-process-definitions.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-process-instances.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-user-authorizations.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-user-task-variables.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-user-tasks.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-users.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-variables.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-decision-definition.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-decision-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-decision-requirements-xml.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-decision-requirements.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-flow-node-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-group.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-incident.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-license.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-process-definition-xml.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-process-definition.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-process-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-role.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-start-process-form.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-tenant.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-user-task-form.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-user-task.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-variable.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/migrate-process-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/modify-process-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/remove-group-from-tenant.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/remove-mapping-rule-from-tenant.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/remove-user-from-tenant.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/report-job-error.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/resolve-incident.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/search-groups.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/search-roles.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/search-tenants.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/sidebar.js
  • docs/apis-tools/camunda-api-rest/specifications/sidebar.ts
  • docs/apis-tools/camunda-api-rest/specifications/unassign-user-from-group.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/unassign-user-task.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/update-authorization.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/update-group.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/update-job.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/update-role.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/update-tenant.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx
  • docs/apis-tools/operate-api/specifications/versions.json
  • docs/apis-tools/tasklist-api-rest/specifications/versions.json
  • docs/apis-tools/zeebe-api-rest/specifications/versions.json

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@pepopowitz pepopowitz mentioned this pull request Jan 17, 2025
43 tasks
@pepopowitz pepopowitz force-pushed the pepopowitz/3736-docusaurus/reintroduce-8-5 branch 2 times, most recently from 70c413f to a16dd74 Compare January 22, 2025 23:06
@pepopowitz pepopowitz force-pushed the pepopowitz/3736-docusaurus/reintroduce-8-5 branch from a16dd74 to 6ba9558 Compare January 24, 2025 21:23
processInstanceVariables: {
type: "array",
description:
"Process Instance variables associated with the user task.",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[all.glossary] This term is spelled, uppercased, lowercased, hyphenated, or used incorrectly. Review the WCoE glossary.

processInstanceVariables: {
type: "array",
description:
"Process Instance variables associated with the user task.",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[all.glossary] This term is spelled, uppercased, lowercased, hyphenated, or used incorrectly. Review the WCoE glossary.

processInstanceVariables: {
type: "array",
description:
"Process Instance variables associated with the user task.",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[all.glossary] This term is spelled, uppercased, lowercased, hyphenated, or used incorrectly. Review the WCoE glossary.

@pepopowitz
Copy link
Collaborator Author

Whoa, a green build!!! I wasn't expecting that at this stage. Merging!

@pepopowitz pepopowitz merged commit 2130861 into pepopowitz/3736-docusaurus-lets-gooooo Feb 4, 2025
6 checks passed
@pepopowitz pepopowitz deleted the pepopowitz/3736-docusaurus/reintroduce-8-5 branch February 4, 2025 20:29
pepopowitz added a commit that referenced this pull request Feb 6, 2025
* d3: bump dependencies to minimum docusaurus 3.0

* d3: remove as many broken things as possible (#4800)

* temp: remove docLayoutComponent setting

* temp: remove old versions

* temp: remove broken theme components

* d3: remove configuration for older versions

* d3: regenerate vNext API docs (#4801)

* d3: regenerate camunda api docs, vNext

* d3: regenerate operate api docs, vNext

* d3: regenerate tasklist api docs, vNext

* d3: regenerate admin sm api docs, vNext

* fix: update badge removal regex and regen vNext API docs to scrub the duplicate badges

* d3: regen 8.6 API docs (#4805)

* feat: rewrite api generation to support older versions; configure v8.6 of operate API generation

* oops: remove notes

* fix: regenerate 8.6 operate api docs to accommodate updated plugin

* feat: configure 8.6 tasklist api generation

* fix: regenerate 8.6 tasklist api docs to accommodate updated plugin

* feat: configure 8.6 admin-sm api generation

* fix: regenerate 8.6 admin-sm api docs to accommodate updated plugin

* feat: configure 8.6 camunda api generation

* fix: regenerate 8.6 camunda api docs to accommodate updated plugin

* fix: revert id of sm-admin 8.6 info page

* feat: configure 8.6 zeebe api generation

* fix: regenerate 8.6 zeebe api docs to accommodate updated plugin

* d3: fix alpha URLs for 8.6 c8 REST API docs (#4828)

* fix: accommodate different alpha URLs per version in C8 REST docs

* fix: regen c8 REST docs for v8.6, with correct alpha URL.

* fix: adapt to change in react-prisma-renderer API

* d3: reintroduce 8.5 docs (#4872)

* d3: reintroduce 8.5 docs

* d3: configure 8.5 operate api docs

* d3: regenerate 8.5 operate api docs

* d3: configure 8.5 tasklist api docs

* d3: regen 8.5 tasklist api docs

* d3: configure 8.5 zeebe api docs

* d3: regen 8.5 zeebe api docs

* fix: remove unused image reference for file that doesn't exist

* fix: adapt to change in react-prisma-renderer API

* regenerate camunda/next api

* regen camunda api

* d3: reintroduce 8.4 docs (#4928)

* reintroduce 8.4 versions

* configure 8.4 operate api docs

* regenerate 8.4 operate api docs

* configure 8.4 tasklist api docs

* regenerate 8.4 tasklist api docs

* fix some broken links

* d3: reintroduce 8.3 docs (#4929)

* reenable 8.3 version

* fix dependency URL

* fix broken links

* remove obsolete config item

* bump to latest docusaurus (#4932)

* the curl icon is dead, long live the curl icon.

* d3: rewrite Metadata override (#4937)

* rewrite Metadata override

* add some guidance for pre-commit hook

* fix tests

* adjust archival theme component based on moved API

* re-introduce DocCard override
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dx Documentation infrastructure typically handled by the Camunda DX team epic:docusaurus3 kind/cleanup Issues related with clean-up the documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

1 participant