Prepare for docusaurus v3

[pepopowitz]

Docusaurus v3 is now in beta and the official release is around the corner. This is the perfect time to start preparing your site for this new major version.

https://docusaurus.io/blog/preparing-your-site-for-docusaurus-v3

There is anecdotal data from the write-the-docs slack that performance is improved in v3.

Tasks

Preview Give feedback

1. Path to Docusaurus 3 #4560
   d3 +1
   
2. Remove {{}} in Optimize update guide links #4561
   component:docs d3 deploy +3
   
3. Add backticks to example #4568
   component:docs d3 +2
   
4. Add backticks #4569
   component:docs d3 +2
   
5. Add backticks for JWT-Token in Connectors HTTP Webhook docs #4570
   component:docs d3 +2
   
6. Replace <= and >= with single chars #4576
   d3 +1
   
7. fix(docusaurus 3): update docs to be mdx v3 compliant #4781
   component:docs dx theme:hygiene +3
   
8. chore: finalize rename of console sm api to administration sm api #4793
   component:docs dx theme:hygiene +3
   
9. fix: use real, actual javascript in api generators #4788
   dx kind/bug +2
   

[akeller]

I saw they anticipate releasing V3 in the next few days unless something big comes up.

[akeller]

I'm glad to see they acknowledged the MDX upgrade and infrastructure changes were the bulk of this release.

I did see two interesting features highlighted:

• Unlisted content
• Code blocks

I don't know how much we'll be able to do with code blocks, but I'm a sucker for interactive experiences.

I didn't realize draft:true was already available for docs and pages (I thought this was a blog only feature). This and the unlisted:true option could help us with some of the feedback that came up in retros around proactive docs authoring or reviewing content without running it locally. CC @christinaausley

☝ I'll create two issues for the draft and unlisted content, respectively. I'd like to see us incorporate a strategy for using the draft feature and then when we move to V3, a strategy for using unlisted.

[akeller]

This came up during our 8.4 docs retro as a possible idea to explore to keep our build times down.

[akeller]

Here is a dump of the npx docusaurus-mdx-checker results - https://docs.google.com/spreadsheets/d/1IvTrYlxrqr1BgOqY8csPDyFH5Rc_2-hrtvajVJskvTY/edit?usp=sharing