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

upgrade: docusaurus 3!!! #4799

Merged
merged 21 commits into from
Feb 6, 2025
Merged

Conversation

pepopowitz
Copy link
Collaborator

@pepopowitz pepopowitz commented Dec 19, 2024

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.

Side-effects

Progress

Steps that could happen in follow-ups, if I need them to

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 marked this pull request as draft December 19, 2024 18:14
* 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
14 tasks
* 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
Copy link
Contributor

github-actions bot commented Dec 19, 2024

👋 🤖 🤔 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-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-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-authorization.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-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-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.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
  • docs/apis-tools/zeebe-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
9 tasks
* 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
@akeller
Copy link
Member

akeller commented Jan 6, 2025

Reintroduce 8.2 docs
We only maintain 8.3+, so you should be able to remove this line, right?

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

* fix: regen c8 REST docs for v8.6, with correct alpha URL.
* 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
@pepopowitz pepopowitz mentioned this pull request Feb 4, 2025
10 tasks
* 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
@pepopowitz
Copy link
Collaborator Author

Curl icon issue solved with a little help from others.

@akeller
Copy link
Member

akeller commented Feb 5, 2025

To investigate: should we be able to see the cookie icon on a preview site?

image

With an Incognito window on my bypass network, I don't see the cookie icon, but I do see the deny/accept modal.

@pepopowitz
Copy link
Collaborator Author

To investigate: should we be able to see the cookie icon on a preview site?

image

With an Incognito window on my bypass network, I don't see the cookie icon, but I do see the deny/accept modal.

➕, and this is how it appears in stage.docs.camunda.io, so I think there is no problem here.

akeller
akeller previously approved these changes Feb 5, 2025
Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

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

I've clicked around on all the interesting pages I can think of: API reference, accordion components, Mark's Connectors update, Optimize instance crossovers, etc., and everything is working as I expected! Poor cURL. Always the bridesmaid.

@github-actions github-actions bot temporarily deployed to camunda-docs February 5, 2025 19:59 Destroyed
* rewrite Metadata override

* add some guidance for pre-commit hook

* fix tests
@github-actions github-actions bot temporarily deployed to camunda-docs February 5, 2025 22:14 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs February 6, 2025 12:59 Destroyed
@pepopowitz
Copy link
Collaborator Author

@akeller I've re-introduced the theme override components, and that's the last thing I'm touching on this PR. When you get a chance, I'd love a re-review/approval!

@github-actions github-actions bot temporarily deployed to camunda-docs February 6, 2025 13:44 Destroyed
@pepopowitz pepopowitz requested a review from akeller February 6, 2025 15:32
Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

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

I rechecked what I clicked through before and saw no issues. If there is something specific I need to look for, please let me know and I will re-review.

@mesellings
Copy link
Contributor

I took a look through and again it all looks good to me - only thing I did notice was an extra bit of padding on h2 elements - I guess a new style was added to the theme, but we can fix this in a follow-up PR as it's no biggie 👍

@mesellings mesellings self-requested a review February 6, 2025 16:12
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

Amazing job, no small feat - approved (one follow-up PR for H2 top padding) 👏 ⭐

@pepopowitz
Copy link
Collaborator Author

I rechecked what I clicked through before and saw no issues. If there is something specific I need to look for, please let me know and I will re-review.

Nope we're good I just needed the paperwork.

@pepopowitz pepopowitz merged commit e6a61bd into main Feb 6, 2025
10 of 11 checks passed
@pepopowitz pepopowitz deleted the pepopowitz/3736-docusaurus-lets-gooooo branch February 6, 2025 16:13
Copy link
Contributor

github-actions bot commented Feb 6, 2025

🧹 Preview environment for this PR has been torn down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy Stand up a temporary docs site with this PR epic:docusaurus3 theme:hygiene Issues related to the theme of hygiene
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants