kusion-docs / kusionstack.io

Source for kusionstack.io site

kusionstack.io

Source for kusionstack.io site https://kusionstack.io.

Powered by Docusaurus 2.

Write documentation for each sub product

Write documentation for sub products in the ./docs/[subProductName] directory.

Build locally

$ rm -rf .docusaurus
$ npm install
$ npm run start

Open http://localhost:3000 in the browser.

Build locally with i18n

$ npm run build
$ npx http-server ./build

Open http://localhost:8080 in the browser.

Tagging a new version for each sub product

1. First, make sure the current docs version (the ./docs/[subProductName] directory) is ready to be frozen.
2. Enter the specified sub product name and a new version number:

npm run docusaurus docs:version:[subProductName] [vMAJOR.MINOR]

# If the sub product has an international document and needs to execute the command again, 
# it will generate the i18n directory corresponding to that version.
npm run write-translations -- --locale [localeName] --override

Example:

npm run docusaurus docs:version:docs v0.12
npm run docusaurus docs:version:kuperator v0.2
npm run docusaurus docs:version:ctrlmesh v0.3
npm run docusaurus docs:version:karpor v0.4

# If the sub product has an international document and needs to execute the command again, 
# it will generate the i18n directory corresponding to that version.
npm run write-translations -- --locale zh --override

Optional sub product names:

• docs (alias for kusion)
• kuperator
• ctrlmesh
• karpor

Format of version number: [vMAJOR.MINOR], e.g. v0.3, v0.13.

When tagging a new version of sub product, the document versioning mechanism will:

• Copy the full docs/[subProductName] folder contents into a new [subProductName]_versioned_docs/version-[versionName]/ folder.
• Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as [subProductName]_versioned_sidebars/version-[versionName]-sidebars.json.
• Append the new version number to [subProductName]_versions.json.

More see:

• Versioning
• Docs Multi-instance

Notice

This website is built under Docusaurus version 2.4.1. There may be unknown errors when compiling on other versions.