constellation/docs
2024-01-08 07:35:48 +01:00
..
docs ci: ignore Wireguard pdf in lychee (#2797) 2024-01-05 14:07:33 +01:00
screencasts docs: update asciinema videos (#2777) 2024-01-08 07:35:48 +01:00
src
static docs: update asciinema videos (#2777) 2024-01-08 07:35:48 +01:00
styles docs: replace reference to CMakeList on main branch with versioned link or Bazel (#2690) 2023-12-08 16:13:39 +01:00
versioned_docs docs: mention TF provider more prominently 2023-12-30 15:44:11 +01:00
versioned_sidebars docs: add release v2.14.0 (#2734) 2023-12-19 17:05:40 +01:00
.gitignore
babel.config.js
docusaurus.config.js
package.json
README.md
sidebars.js terraform-provider: cleanup and improve docs (#2685) 2023-12-14 15:47:55 +01:00
versions.json docs: add release v2.14.0 (#2734) 2023-12-19 17:05:40 +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.