constellation/docs
renovate[bot] dda426a51e
deps: update ubuntu:22.04 Docker digest to a6d2b38 (#3084)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-05-13 10:18:56 +02:00
..
docs terraform: add missing policies for AWS ALB (#3063) 2024-05-10 08:51:32 +02:00
screencasts deps: update ubuntu:22.04 Docker digest to a6d2b38 (#3084) 2024-05-13 10:18:56 +02:00
src docs: change to inter font (#2989) 2024-03-15 15:38:34 +01:00
static Small changes in docs/README (#3050) 2024-04-30 16:01:56 +02:00
styles docs: document STACKIT CC features 2024-03-11 16:43:36 +01:00
versioned_docs docs: update images with inter font (#2995) 2024-04-08 07:28:01 +02:00
versioned_sidebars docs: add release v2.16.0 2024-02-29 17:22:19 +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: update clouds and marketplaces 2024-01-24 09:57:35 +01:00
versions.json docs: add release v2.16.0 2024-02-29 17:22:19 +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.