Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-09-20 00:06:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
fcc46d6bf2
constellation/docs
History
renovate[bot] 2829e59eef deps: update ubuntu:22.04 Docker digest to aabed32
2023-09-26 13:08:22 +02:00
..
docs doc: --skip-flag in the upgrade workflow (#2313) 2023-09-09 15:26:18 +02:00
screencasts deps: update ubuntu:22.04 Docker digest to aabed32 2023-09-26 13:08:22 +02:00
src docs: embedd asciinema casts (#1154) 2023-03-11 00:13:32 +01:00
static docs: update screencasts to demo node groups (#2243) 2023-08-16 13:50:31 +02:00
styles docs: add a qemu section (#1724) 2023-05-17 13:21:35 +00:00
versioned_docs docs: add release v2.11.0 (#2330) 2023-09-14 15:54:27 +02:00
versioned_sidebars docs: add release v2.11.0 (#2330) 2023-09-14 15:54:27 +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: switch to native mermaid support (#2306) 2023-09-05 11:24:20 +02: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 vault benchmark (#2271) 2023-08-24 15:52:05 +02:00
versions.json docs: add release v2.11.0 (#2330) 2023-09-14 15:54:27 +02:00

README.md

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.