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.

Sign up for GitHub

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

Jump to bottom

upgrade: docusaurus 3!!! #4799

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

upgrade: docusaurus 3!!! #4799

wants to merge 5 commits into from
+86,809 −22,726

Conversation

pepopowitz
Copy link
Collaborator

@pepopowitz pepopowitz commented Dec 19, 2024 •
edited
Loading

Description

Addresses #3736.

This is the mainline for upgrading to docusaurus 3!!!

It is currently in progress.

About this branch

  • I expect it to be long-living.
  • It will not merge into main until the entire site is working in docusaurus 3, obviously.
  • When updating this branch from main, we'll need to re-generate API docs for any APIs whose spec changes.
  • I will open PRs into this branch as I go.

Progress

  • Bump dependencies to minimum viable d3 version (3.0.1). This will isolate d2->d3 upgrade issues from d3.0.1->d3.6.3 upgrade issues. (this PR)
  • d3: remove as many broken things as possible #4800 - Remove all old versions & broken theme components. This will allow us to fix one version at a time, and get as close to green as possible as we iterate.
  • Make next/current versions of docs green (or as green as possible).
  • Resolve alpha link errors in build from 8.6 API docs (see https://github.com/camunda/camunda-docs/actions/runs/12439147000/job/34732411315)
    • The issue is that the camunda strategy adds links for alpha features, which were recently removed for vNext.
    • I think the fix is to remove that step from the strategy.
  • Reintroduce 8.5 docs
    • Regenerate Operate REST API docs
    • Regenerate Tasklist REST API docs
    • Regenerate Zeebe REST API docs
  • Reintroduce 8.4 docs
    • Regenerate Operate REST API docs
    • Regenerate Tasklist REST API docs
  • Reintroduce 8.3 docs
  • Reintroduce 8.2 docs
  • Replace docLayoutComponent setting in configuration.
  • Rewrite/reintroduce src/theme/DocCard theme component (usage of findFirstCategoryLink)
  • Rewrite/reintroduce src/theme/DocItem/Metadata theme component (usage of useDocsVersion)
  • Rewrite/reintroduce src/hacks/isolateVersion/assets/theme/DocVersionBanner theme component template (usage of useDocsVersion)
  • Bump dependencies to _most recent d3 version (currently 3.6.3)

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 added theme:hygiene Issues related to the theme of hygiene epic:docusaurus3 labels Dec 19, 2024
@pepopowitz pepopowitz self-assigned this Dec 19, 2024
@pepopowitz pepopowitz mentioned this pull request Dec 19, 2024
Open
@pepopowitz pepopowitz marked this pull request as draft December 19, 2024 18:14
@pepopowitz pepopowitz mentioned this pull request Dec 19, 2024
Merged
9 tasks
@pepopowitz
d3: remove as many broken things as possible (#4800)
6d5ef83 
* temp: remove docLayoutComponent setting

* temp: remove old versions

* temp: remove broken theme components

* d3: remove configuration for older versions
@pepopowitz pepopowitz mentioned this pull request Dec 19, 2024
Merged
14 tasks
@pepopowitz
Merge branch 'main' into pepopowitz/3736-docusaurus-lets-gooooo
6847a7b
@pepopowitz
d3: regenerate vNext API docs (#4801)
237c326 
* 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
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 19, 2024 •
edited
Loading

👋 🤖 🤔 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/administration-sm-api/sidebar-schema.js
  • docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed.info.mdx
  • docs/apis-tools/administration-sm-api/specifications/versions.json
  • docs/apis-tools/camunda-api-rest/sidebar-schema.js
  • 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-to-tenant.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/correlate-message.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-element-instance-variables.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-group.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-mapping-rule.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-role.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-tenant.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-user.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/delete-document.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-role.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/delete-tenant.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/delete-user.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-authentication.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-document.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-topology.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-usage-metrics.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/pin-clock.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/publish-message.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/reset-clock.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/unassign-user-from-group.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/versions.json
  • docs/apis-tools/operate-api/sidebar-schema.js
  • docs/apis-tools/operate-api/specifications/versions.json
  • docs/apis-tools/tasklist-api-rest/sidebar-schema.js
  • docs/apis-tools/tasklist-api-rest/specifications/versions.json
These files were changed only in versioned_docs/version-8.6/. You might want to duplicate these changes in docs/.
  • versioned_docs/version-8.6/apis-tools/administration-sm-api/specifications/sm-administration-api.info.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/correlate-a-message.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/create-document-link-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/delete-document-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/deploy-resources.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/download-document-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/find-all-users.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-cluster-topology.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-incident-by-key-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/get-status-of-camunda-license.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/pin-internal-clock-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/publish-a-message.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-definitions-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-instances-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-decision-requirements-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-flow-node-instances-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-incidents-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-process-instances-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/query-user-tasks-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/report-error-for-job.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/reset-internal-clock-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/update-a-job.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/update-element-instance-variables.api.mdx
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/specifications/upload-document-alpha.api.mdx
  • versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/assign-a-user-task.api.mdx
  • versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/complete-a-user-task.api.mdx
  • versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/get-cluster-topology.api.mdx
  • versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/sidebar.js
  • versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/sidebar.ts
  • versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/unassign-a-user-task.api.mdx
  • versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/update-a-user-task.api.mdx
  • versioned_docs/version-8.6/apis-tools/zeebe-api-rest/specifications/zeebe-rest-api.info.mdx

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 Dec 20, 2024
Merged
9 tasks
@pepopowitz
d3: regen 8.6 API docs (#4805)
8d17237 
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@pepopowitz pepopowitz

Labels
epic:docusaurus3 theme:hygiene Issues related to the theme of hygiene
Projects
Developer Experience
Status: 🏗 In Progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@pepopowitz