constellation/docs
2023-12-08 13:59:51 +01:00
..
docs deps: update Kubernetes versions 2023-12-08 13:59:51 +01:00
screencasts docs: update screencasts to use apply command (#2624) 2023-11-21 16:03:11 +01:00
src docs: embedd asciinema casts (#1154) 2023-03-11 00:13:32 +01:00
static docs: fix deploy preview and some links 2023-11-23 22:43:10 +01:00
styles s3proxy: add new page to documentation (#2417) 2023-10-10 15:35:23 +02:00
versioned_docs docs: add release v2.13.0 2023-11-19 18:57:31 +01:00
versioned_sidebars docs: add release v2.13.0 2023-11-19 18:57:31 +01:00
.gitignore Add docs to repo (#38) 2022-09-02 11:52:42 +02:00
babel.config.js Add docs to repo (#38) 2022-09-02 11:52:42 +02:00
docusaurus.config.js docs: fix deploy preview and some links 2023-11-23 22:43:10 +01:00
package.json docs: switch to native mermaid support (#2306) 2023-09-05 11:24:20 +02:00
README.md AB#2685 Add documentation for automatic IAM creation (#711) 2022-12-12 13:33:19 +01:00
sidebars.js docs: add Terraform module (#2560) 2023-11-16 17:03:24 +01:00
versions.json docs: add release v2.13.0 2023-11-19 18:57:31 +01:00

Constellation Documentation

Published @ https://docs.edgeless.systems/constellation via netlify.

Previewing

During edits you can preview your changes using the docusaurus:

# requires node >=16.14
npm install
npm run build
npm run serve

Browse to http://localhost:3000/constellation and choose the "Next" version in the top right.

Release process

  1. Tagging a new version

    npm run docusaurus docs:version X.X
    

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

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