Upgrade Docusaurus from 3.7.0 to 3.9.1 #1564
Conversation
The onBrokenMarkdownLinks option was removed from the root config and added under markdown.hooks to align with updated Docusaurus configuration structure. This change complies with a change made in Docusaurus 3.9: facebook/docusaurus#11283
When labels have duplicate names, the sidebar must contain a `key` attribute. Without these `key` attributes, Docusaurus 3.9 (and likely later unless this specification changes) will encounter errors during the build process. As described in the Docusaurus blog post for 3.9: "In #11228, we added a new `key` attribute to the docs sidebar items, allowing to assign explicit translation keys to each sidebar item that use the same label and would otherwise lead to translation key conflicts." Related Docusaurus PR: facebook/docusaurus#11228
Summary of ChangesHello @josh-wong, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on a significant infrastructure update by upgrading Docusaurus to version 3.9. The primary motivation for this upgrade is to resolve build issues related to duplicate sidebar labels, which required adding unique Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
josh-wong
changed the title
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request effectively upgrades Docusaurus to version 3.9. The changes are comprehensive, covering dependency updates, configuration adjustments, and the necessary addition of unique key attributes to sidebar items across all versions to prevent build failures. The fixes for the Japanese documentation metadata and notification URL are also valuable improvements. I've found one minor issue with another URL in the notifications file that seems to have been overlooked. Otherwise, this is a solid update.
| en: 'requirements?RDBs=Db2#relational-databases?utm_source=docs-site&utm_medium=notifications', | ||
| ja: 'scalardb-cluster/getting-started-with-vector-search?RDBs=Db2#リレーショナルデータベース?utm_source=docs-site&utm_medium=notifications' | ||
| ja: 'scalardb-cluster/authorize-with-abac?utm_source=docs-site&utm_medium=notifications' |
There was a problem hiding this comment.
You've correctly fixed the malformed URL for the Japanese notification. That's a great catch! However, it looks like the English URL on the line above has a similar issue. It contains two ? characters, which makes the URL invalid. The fragment identifier (#relational-databases) should also be at the end of the URL.
To ensure the link works correctly for English-speaking users, it should be reformatted.
| en: 'requirements?RDBs=Db2#relational-databases?utm_source=docs-site&utm_medium=notifications', | |
| ja: 'scalardb-cluster/getting-started-with-vector-search?RDBs=Db2#リレーショナルデータベース?utm_source=docs-site&utm_medium=notifications' | |
| ja: 'scalardb-cluster/authorize-with-abac?utm_source=docs-site&utm_medium=notifications' | |
| en: 'requirements?RDBs=Db2&utm_source=docs-site&utm_medium=notifications#relational-databases', | |
| ja: 'scalardb-cluster/authorize-with-abac?utm_source=docs-site&utm_medium=notifications' |
Change as suggested by Gemini code review: #1564 (comment)
Added logic to create the output directory if it does not exist before writing the glossary JSON file. This prevents errors when the specified output path's directory is missing.
Bump Node.js version from `18` to `20` in deploy and test-deploy GitHub Actions workflows to ensure compatibility with the latest Node.js features and security updates. This is necessary because Docusaurus 3.9 drops support for Node.js 18: https://docusaurus.io/blog/releases/3.9#dropping-nodejs-18
Introduced a colorMode section in the Docusaurus config to set the default mode to light, enable the color mode switch, and respect the user's preferred color scheme.
1 participant
Description
This PR upgrades Docusaurus (our static site generator) from version 3.7.0 to 3.9.1.
Aside from updating dependencies, the most significant change includes adding the new
keyattribute to items with the same label in the version sidebar navigation. For example, we use the sameReferencelabel in multiple different places in the sidebar; but without adding a uniquekeyattribute, errors occur when trying to build the site. Adding this attribute is necessary without thekeyattribute for those items that have the same label, Docusaurus 3.9 (and likely later unless this specification changes) will encounter errors during the build process.As described in the Docusaurus blog post for 3.9: "In #11228, we added a new
keyattribute to the docs sidebar items, allowing to assign explicit translation keys to each sidebar item that use the same label and would otherwise lead to translation key conflicts."To see how the site looks with Docusaurus 3.9, see the following staging site: https://68e35a1be3edf296d271c3f8--reliable-phoenix-b90994.netlify.app/docs/latest/
Related issues and/or PRs
N/A
Changes made
3.7.0to3.9.1inpackage.jsonfor improved stability and access to new features.onBrokenMarkdownLinks: 'ignore'configuration from the root ofdocusaurus.config.jsto themarkdown.hookssection, and addedonDuplicateRoutes: 'warn'to handle duplicate routes more gracefully.colorModetodocusaurus.config.jsto respect the user's light/dark theme preference set in their OS.keyattribute in the sidebar navigationkeyattributes to all sidebar navigation items that have the same label in all sidebar versions. This prevent duplicate route issues, which cause Docusaurus not to build in 3.9.Checklist
Additional notes (optional)
N/A