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

Update docusaurus to v3+ #3736

Open
Tracked by #3734
pepopowitz opened this issue Apr 26, 2024 · 1 comment
Open
Tracked by #3734

Update docusaurus to v3+ #3736

pepopowitz opened this issue Apr 26, 2024 · 1 comment
Assignees
Labels
dx Documentation infrastructure typically handled by the Camunda DX team kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) theme:hygiene Issues related to the theme of hygiene

Comments

@pepopowitz
Copy link
Collaborator

pepopowitz commented Apr 26, 2024

Must follow #2719.

See #4799 for work breakdown and progress.

Implementation notes

  • This might be a nice forcing function to permanently introduce generation of older API docs (which would have been nice for something like Update operate-openapi.yaml #4736).
    • The biggest challenge with this is that the api doc generator emits a typescript sidebar schema file, but the versioned docs require one flat JSON sidebar schema at the version root.
    • But it might not be too bad to hack, because the generated typescript sidebar schema merely exports a single JSON document, and doesn't have any actual javascript functionality.
@pepopowitz pepopowitz self-assigned this Apr 26, 2024
@pepopowitz pepopowitz added kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) dx Documentation infrastructure typically handled by the Camunda DX team theme:hygiene Issues related to the theme of hygiene labels Apr 26, 2024
@pepopowitz pepopowitz moved this from 🆕 Inbox to 🏗 In Progress in Developer Experience Apr 26, 2024
@pepopowitz pepopowitz moved this from 🏗 In Progress to 🔖 Ready in Developer Experience Apr 26, 2024
@pepopowitz
Copy link
Collaborator Author

A note to inspire a little more urgency/relevance for this issue:

I am working on #3649, and wanted to tackle https://github.com/camunda/developer-experience/issues/38 while there, but couldn't because of our older version of docusaurus.

Basically, I wanted to utilize markdown imports to extract a shared authentication document, but because of this issue, I would have had to write the entire document as html instead of markdown. I then looked into updating to mdx v2 via a theme for docusaurus v2, but even that had issues that would have caused me to rewrite a ton of unrelated content.

If we'd been updated to docusaurus v3, theoretically, my markdown imports should have worked without unrelated changes.

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 kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) theme:hygiene Issues related to the theme of hygiene
Projects
Status: 🔖 Ready
Development

No branches or pull requests

1 participant