Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-12-17 20:04:36 -05:00
Code Issues Packages Projects Releases Wiki Activity
3b6bc3b28f
constellation/docs
History
Moritz Eckert bffa5c580c
Fix components diagram (#659)
2022-11-28 15:30:46 +01:00
..
docs Provenance for CLI (#647) 2022-11-25 16:13:20 +01:00
src Rewrite install.md and create verify-cli.md (#124) 2022-09-12 18:35:12 +02:00
static Recude speed for asciicinema (#150) 2022-09-14 15:28:33 +02:00
styles sbom signing (#303) 2022-10-21 15:19:51 +02:00
versioned_docs Fix components diagram (#659) 2022-11-28 15:30:46 +01:00
versioned_sidebars docs: publish access manager removal 2022-11-14 10:42:30 +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 Rewrite install.md and create verify-cli.md (#124) 2022-09-12 18:35:12 +02:00
README.md Add docs to repo (#38) 2022-09-02 11:52:42 +02:00
sidebars.js Docs: document breaking changes in the config file 2022-11-23 15:47:46 +01:00
versions.json release docs for v2.2 (#482) 2022-11-08 18:25:56 +01: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

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.