mirror of
https://github.com/edgelesssys/constellation.git
synced 2024-09-20 00:06:21 +00:00
49e5a17aec
* document backup files on upgrade Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * reword TF backup * Update docs/docs/workflows/upgrade.md Co-authored-by: Otto Bittner <cobittner@posteo.net> * Update docs/docs/workflows/upgrade.md Co-authored-by: Otto Bittner <cobittner@posteo.net> * Update docs/docs/workflows/upgrade.md Co-authored-by: Otto Bittner <cobittner@posteo.net> * Update upgrade.md Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com> --------- Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> Co-authored-by: Otto Bittner <cobittner@posteo.net> Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| docs | ||
| screencasts | ||
| src | ||
| static | ||
| styles | ||
| versioned_docs | ||
| versioned_sidebars | ||
| .gitignore | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| versions.json | ||
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.XWhen 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.