Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-12-29 01:16:12 -05:00
Code Issues Packages Projects Releases Wiki Activity
19b67dc622
constellation/docs
History
github-actions[bot] 74c3c93dec
Update CLI reference (#248) 
Co-authored-by: katexochen <49727155+katexochen@users.noreply.github.com>
2022-10-14 10:48:20 +02:00
..
docs Update CLI reference (#248) 2022-10-14 10:48:20 +02: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 AB#2425 Constellation mini docs (#214) 2022-10-07 09:42:14 +02:00
versioned_docs Update wording for MiniConstellation in docs (#241) 2022-10-13 11:29:56 +02:00
versioned_sidebars Update wording for MiniConstellation in docs (#241) 2022-10-13 11:29:56 +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: fix some code highlightings 2022-09-12 18:52:05 +02: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 Update wording for MiniConstellation in docs (#241) 2022-10-13 11:29:56 +02:00
versions.json Release docs for v2.1 (#222) 2022-10-07 12:14:55 +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

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.