Hello all,
We've been working on upgrading druid.apache.org to use Docusaurus 3 since
that project has moved to more frequent but smaller releases. They're
currently releasing 3.7 while we're on 2.4.3.
When the upgrade is complete, the main user facing changes will be the
following:
- You now need to escape left curly braces `{` and `<` or place them in
code ticks when appropriate.
- Docusaurus 3 uses MDX v3, which is stricter with syntax. The curly
brace is often used with the DRUIDVERSION variable. So instead of
{{DRUIDVERSION}}, please use \{\{DRUIDVERSION}} or else your build will
fail with the following error msg: Could not parse expression with acorn:
Unexpected content after expression.
- You need to perform a yarn/npm run install in the `druid/website`
directory in the main Druid repo and in the root of the `druid-website-src`
repo.
- We will use configs in docusaurus.config.js to maintain backwards
compatibility for some syntax that has been deprecated, such as for
admonitions. The syntax will be updated at a future date. Specifically the
following:
- HTML comments are deprecated, use MDX comments instead {/* comments
*/}
- Admonition titles
- Manually heading ids
You can read more about the upgrade process here:
https://docusaurus.io/docs/migration/v3
Best,
Brian
