Update Docusaurus to newest version

kickoke commented 2 years ago

Problem

Currently, we are using Docusaurus 2.0.0 beta. To make use of some features that have been added in later versions, we want to update to Docusaurus 2.0.0 beta17. However, the theme was adapted with custom code ("swizzled" is the docusaurus lingo).

However, these custom components prevent us to seamlessly update to the latest version. Especially the CSS has broken. I was able to resurrect most features, see PR #921. However the main issues are:

Styling: Dark theme is broken
DocSidebar: The table of contents (also called sidebar) looks a bit different. For example, on the current version of learn.netdata.cloud there are custom dividers, which are not in the vanilla code. The current file contains a loot of custom code, and I couldn't make sense of it Vanilla code: https://github.com/netdata/learn/tree/staging1/src/theme/DocSidebar Current code: https://github.com/netdata/learn/tree/master/src/theme/DocSidebar

More information/ resources

Branch: staging1 Preview: https://staging1--netdata-docusaurus.netlify.app/docs/

About custom code (swizzling): 📄 Swizzled Components in Learn 📄 Docusaurus Docs - Sidebar 📄 Docusaurus docs - Styling 📄 Infima design system

Custom code: 📁 Customized Theme components 📁 Custom CSS Components can have custom CSS as well, but then it is in the styles.module.css file that lies in the same folder as the component.

@novykh Can you check who can help us out? :)

tkatsoulas commented 2 years ago

[Minor] This https://github.com/netdata/learn/commit/f28bcd57f4be0a6463964239629ccdd1ca293369 commit says beta.14, it's a typo. it's beta.15

kickoke commented 2 years ago

@tkatsoulas I think in the meantime they even released beta.16. We could update to the latest version while we are in this limbo...

tkatsoulas commented 2 years ago

@kickoke we will probably have to go to beta.17 since this effort is still in progress. I am looking forward to a stable not beta release from docusaurus

Current version (Stable)
Here you can find the documentation for current released version.
2.0.0-beta.17 | Documentation | Release Notes -- | -- | --
Current version (Stable) Here you can find the documentation for current released version. 2.0.0-beta.17 [Documentation](https://docusaurus.io/docs) [Release Notes](https://github.com/facebook/docusaurus/releases/tag/v2.0.0-beta.17) Next version (Unreleased) Here you can find the documentation for work-in-process unreleased version. 2.0.0-beta.18 🚧 [Documentation](https://docusaurus.io/docs/next) Past versions (Not maintained anymore) Here you can find documentation for previous versions of Docusaurus. 2.0.0-beta.16 [Documentation](https://docusaurus.io/docs/2.0.0-beta.16) [Release Notes](https://github.com/facebook/docusaurus/releases/tag/v2.0.0-beta.16) 2.0.0-beta.15 [Documentation](https://6220d0362c028b000827f851--docusaurus-2.netlify.app/docs/2.0.0-beta.15) [Release Notes](https://github.com/facebook/docusaurus/releases/tag/v2.0.0-beta.15) source: https://docusaurus.io/versions

kickoke commented 2 years ago

Solved by #963

netdata / learn