Our documentation is versioned. All sections are versioned together, this includes products that do not have a fixed release cycle (such as Console, Web Modeler, and Connectors).
Due to a difference in version numbers, the documentation is split into multiple Docusaurus "instances". Documentation specific to Optimize lives in the optimize instance, and all other documentation lives in the main docs instance.
Depending on the instance and version, location of source files and sidebar navigation definition varies:
| Instance | Version(s) | Source path | Sidebars path |
|---|---|---|---|
docs |
Next | /docs/ | sidebars.js |
docs |
8.0, 1.3, 1.2, ... | /versioned_docs/version-*/ | versioned_sidebars/version-*-sidebars.json |
optimize |
Next | /optimize/ | optimize_sidebars.js |
optimize |
3.8.0, 3.7.0, ... | /optimize_versioned_docs/version-*/ | /optimize_versioned_sidebars/version-*-sidebars.json |
Several sections of the sidebar navigation are shared across the Optimize and main sections of the docs: Components, Self-Managed, and APIs & Clients. To preserve a consistent user experience in the docs, the structure of sidebars should always match across instances for these sections. When it doesn't match, the user will experience sections of navigation appearing and disappearing depending on which doc they're reading.
It's likely that the structure will drift over time. To resolve the drift, see the docs on generating sidebars.
New versions are created as part of the release process.
The Docusaurus documentation provides a detailed explanation of versioning at https://v2.docusaurus.io/docs/versioning/.