constellation/docs
Otto Bittner 861bc84f94
cli: only apply upgrades on gcp/azure (#1518)
The constellation-operator currently doesn't support the
necessary operations for AWS, OpenStack and QEMU.
2023-03-24 17:07:14 +01:00
..
docs cli: only apply upgrades on gcp/azure (#1518) 2023-03-24 17:07:14 +01:00
screencasts deps: update ubuntu:22.04 Docker digest to 7a57c69 (#1452) 2023-03-17 18:31:20 +01: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: embedd asciinema casts (#1154) 2023-03-11 00:13:32 +01:00
versioned_docs docs: refer to known issues (#1414) 2023-03-14 08:27:06 +01:00
versioned_sidebars docs: add release v2.6.0 2023-03-09 13:14:28 +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 Add plausbile to docusaurus (#456) 2022-11-04 14:15:34 +01:00
package.json docs: embedd asciinema casts (#1154) 2023-03-11 00:13:32 +01:00
README.md AB#2685 Add documentation for automatic IAM creation (#711) 2022-12-12 13:33:19 +01:00
sidebars.js docs: few fixes and rewording 2023-03-06 10:43:49 +01:00
versions.json docs: add release v2.6.0 2023-03-09 13:14:28 +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.