tree: 7280524589ee176e38c1e041ee5e18a5a441c97f [path history] [tgz]
  1. website/
  2. README.md
site3/README.md

Website

How to change the documentation

The “next” release doc is under docs directory. If you need to edit the sidebar, you have to modify sidebars.json file.

How to add a new release

Patch release

In order to add the release you have to follow the official Docusaurus guide

Ensure you have yarn installed.

For each minor release only the latest patch version documentation is kept.

LATEST_RELEASED=4.14.4
NEW_RELEASE=4.14.5

cd site3/website
yarn run docusaurus docs:version $NEW_RELEASE
rm -rf versioned_docs/version-${LATEST_RELEASED}
rm -rf versioned_sidebars/version-${LATEST_RELEASED}-sidebars.json

# remove $LATEST_RELEASED from versions.json

Then you have to:

  • remove $LATEST_RELEASED from versions.json
  • add release notes for the new release in the src/pages/release-notes.md file.
    • commit and push the changes

Major/minor release

NEW_RELEASE=4.15.0

cd site3/website
yarn install
yarn run docusaurus docs:version $NEW_RELEASE

Then you have to:

  • add release notes for the new release in the src/pages/release-notes.md file.
  • commit and push the changes