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 to Docusaurus v3 #667

Merged
merged 60 commits into from
Dec 10, 2024
Merged

Upgrade to Docusaurus v3 #667

merged 60 commits into from
Dec 10, 2024

Conversation

sserrata
Copy link
Member

@sserrata sserrata commented May 15, 2024

Description

WHAT:

  • Upgrading Docusaurus to latest 3.6.3 release for pan.dev
  • Upgrading the OpenAPI plugin to latest release with v3 support

WHY:

  • Faster builds and better developer/contributing experience!
  • Improvements to OpenAPI plugin/theme

CHANGES:

  • sidebars.js have been renamed to sidebars.ts

OTHER:

  • Important reminder that md and mdx files are now handled differently. Please stick to using md extension unless you need an MDX/JSX specific component.
  • PRs currently open will likely have merge conflicts after the upgrade is complete. Since I cannot tell which PRs we are actually planning to merge, please reach out here if you need some help resolving those conflicts.

Preview: https://pan-dev-f1b58--pr667-4fkdzexb.web.app/

TODO:

  • Refactor sidebars.js to sidebars.ts modules
  • Refactor all sidebar.js to sidebar.ts modules
  • Refactor docusaurus config as necessary
  • Address all MDX syntax errors (mostly expedition and swfw docs)

@sserrata sserrata self-assigned this May 15, 2024
@sserrata sserrata requested a review from a team as a code owner May 15, 2024 16:04
@sserrata sserrata changed the title Test upgrading to @docusaurus/core and docusaurus-openapi-docs to v3 Test upgrading @docusaurus/core and docusaurus-openapi-docs to v3 May 17, 2024
@sserrata sserrata added the chore Routine maintenance label Jun 6, 2024
@sserrata sserrata requested review from a team as code owners July 11, 2024 17:36
@sserrata sserrata force-pushed the upgrade-v3 branch 2 times, most recently from cf4baba to 940c9e3 Compare July 11, 2024 18:53
@sserrata
Copy link
Member Author

Build is currently failing with an error similar to the one reported here: facebook/docusaurus#9907

Copy link

github-actions bot commented Jul 12, 2024

Visit the preview URL for this PR (updated for commit 6d34750):

https://pan-dev-f1b58--pr667-4fkdzexb.web.app

(expires Thu, 09 Jan 2025 22:53:59 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 9359a9fa100d5fdb082f75280473a90b1f96eb51

@sserrata sserrata removed sase Use this label to trigger sase product builds contributing Use this label to trigger contributing guideline builds labels Oct 16, 2024
@sserrata
Copy link
Member Author

sserrata commented Dec 3, 2024

@blindaa121 just upgraded to latest docusaurus and openapi plugin canary. Aside from the merge conflicts we'll also want to make sure we pull in all the changes that occurred since the last time I updated this branch.

@sserrata sserrata changed the title Test upgrading @docusaurus/core and docusaurus-openapi-docs to v3 Upgrade to Docusaurus v3 Dec 6, 2024
@blindaa121 blindaa121 merged commit 1c13641 into master Dec 10, 2024
6 checks passed
@blindaa121 blindaa121 deleted the upgrade-v3 branch December 10, 2024 23:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants