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

docs: upgrade to docusaurus 3 #17740

Open
wants to merge 20 commits into
base: master
Choose a base branch
from

Conversation

317brian
Copy link
Contributor

@317brian 317brian commented Feb 19, 2025

Used the docusaurus syntax checker to clean up the errors so that the site will comply with MDX v3

npx docusaurus-mdx-checker

This update to the build/copy script in druid-website-src needs to be reviewed and merged to accomdodate the escaped DRUIDVERSION variable: apache/druid-website-src#519

The best way to review this is concurrently with 519. Run the do all things script in 519 and verify the prod output with yarn/npm run serve

This also upgrades the backend to Docusaurus 3 since there are differences in acceptable syntax between 2 and 3

This PR has:

  • been self-reviewed.

Sorry, something went wrong.

(cherry picked from commit 91ec717)
(cherry picked from commit 854dccb)
(cherry picked from commit 27dfa07)
@317brian 317brian marked this pull request as ready for review February 20, 2025 21:25

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Co-authored-by: Victoria Lim <[email protected]>

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
This reverts commit ba1841f.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
* docs: docusaurus3 upgrade

* more fixes
@317brian 317brian marked this pull request as draft March 13, 2025 00:32

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@317brian 317brian marked this pull request as ready for review March 26, 2025 22:52
@317brian 317brian changed the title docs: clean up markdown syntax for docusaurus 3 docs: upgrade to docusaurus 3 Mar 26, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Copy link
Member

@vtlim vtlim left a comment

Choose a reason for hiding this comment

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

LGTM 🦖

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants