Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-01-11 15:39:33 -05:00
Code Issues Packages Projects Releases Wiki Activity
59b9d54c44
constellation/docs/README.md
3u13r 521ff0d14c
Pin crane and npm dependencies (#3477) 
* ci: pin crane dependency

* docs: pin npm dependencies

* deps: bump docusaurus

---------

Co-authored-by: Thomas Tendyck <tt@edgeless.systems>
2024-11-20 18:34:25 +01:00

998 B
Raw Blame History

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 ci # Install pinned dependencies
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.