Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To release the documentation, first run the following command to create a new doc version:

Code Block
languagebash
titleCreate a new doc version
npm run docusaurus docs:version <VERSION-NUMBER>

In docusaurus.config.js , under presets > classic > docs > version , add :

  • Under versions :
    • Add the new version and

...

    • set its label to stable (<VERSION-NUMBER>) and

...

    • its path to stable .
    • Update the previous version to remove the stable  label and path, and add an unmaintained  banner.
  • Update the lastVersion  to the

...

  • version number.

For example, when updating from version 23.4.1  to 23.4.2 , update the following section in docusaurus.config.js  from the following:

Code Block
languagejs
titledocusaurus.config.js (before)
lastVersion: "23.4.1",
versions: {
  current: {
    label: "development",
    path: "development",
    banner: "unreleased",
  },
  "23.4.1": {
    label: "stable (23.4.1)",
    path: "stable",
    banner: "none",
  },
  "23.4.0": {
    label: "23.4.0",
    path: "23.4.0",
    banner: "unmaintained",
  },
},

...

Code Block
languagejs
titledocusaurus.config.js (after)
lastVersion: "23.4.2",
versions: {
  current: {
    label: "development",
    path: "development",
    banner: "unreleased",
  },
  "23.4.2": {
    label: "stable (23.4.2)",
    path: "stable",
    banner: "none",
  },
  "23.4.1": {
    label: "23.4.1",
    path: "23.4.1",
    banner: "unmaintained",
  },
  "23.4.0": {
    label: "23.4.0",
    path: "23.4.0",
    banner: "unmaintained",
  },
},

...