constellation/docs
2023-08-11 15:18:59 +02:00
..
docs cli: upgrade uses same helm releases as init (#2177) 2023-08-11 15:18:59 +02:00
screencasts docs: remove deprecated flags from docs 2023-08-04 12:36:45 +02:00
src docs: embedd asciinema casts (#1154) 2023-03-11 00:13:32 +01:00
static docs: simplify readme svg (#1418) 2023-03-15 12:11:54 +01:00
styles docs: add a qemu section (#1724) 2023-05-17 13:21:35 +00:00
versioned_docs ci: remove Azure portal internal links from docs (#2122) 2023-07-20 15:04:34 +02:00
versioned_sidebars docs: add release v2.9.0 (#2102) 2023-07-14 16:24:05 +02: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: enable ga and cookie banner (#1986) 2023-06-30 14:42:55 +02:00
package.json docs: enable ga and cookie banner (#1986) 2023-06-30 14:42:55 +02:00
README.md AB#2685 Add documentation for automatic IAM creation (#711) 2022-12-12 13:33:19 +01:00
sidebars.js aws: use new LB controller to fix SecurityGroup cleanup on K8s service deletion (#2090) 2023-07-24 10:30:53 +02:00
versions.json docs: add release v2.9.0 (#2102) 2023-07-14 16:24:05 +02: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.