mirror of
https://github.com/edgelesssys/constellation.git
synced 2025-01-30 01:03:31 -05:00
b278b76df5
* Refactor benchmark structure * Add vault-benchmark section * update 2.10 docs Co-authored-by: Otto Bittner <cobittner@posteo.net> Co-authored-by: Thomas Tendyck <tt@edgeless.systems>
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
-
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 newversioned_docs/version-[versionName]/
folder. Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved asversioned_sidebars/version-[versionName]-sidebars.json
. Append the new version number toversions.json
.