Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-10-01 01:36:09 -04:00
Code Issues Packages Projects Releases Wiki Activity
eb213878a2
constellation/docs
History
Felix Schuster eb213878a2
Re-wording in docs/workflows (#135) 
* Quick pass over create.md

* pass over verify.md

* Re-arrange workflows

* Quick polish of scale.md and upgrade.md

* Quick polish of terminate.md

* Cut recovery.md down

* Brush over ssh

* storage

* Brush over trusted launch VMs

* Update docs/docs/workflows/verify-cluster.md

Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>

* Update docs/docs/workflows/verify-cluster.md

Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>

* Update docs/docs/workflows/verify-cluster.md

Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>

* Add Azure back to title

* Update docs/docs/workflows/verify-cluster.md

Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>

* fix lint errors

* publish to 2.0

Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>
Co-authored-by: Thomas Tendyck <tt@edgeless.systems>
2022-09-13 15:12:05 +02:00
..
docs Re-wording in docs/workflows (#135) 2022-09-13 15:12:05 +02:00
src Rewrite install.md and create verify-cli.md (#124) 2022-09-12 18:35:12 +02:00
static Update concept graphic in README (#136) 2022-09-13 11:31:52 +02:00
styles Rewrite install.md and create verify-cli.md (#124) 2022-09-12 18:35:12 +02:00
versioned_docs/version-2.0 Re-wording in docs/workflows (#135) 2022-09-13 15:12:05 +02:00
versioned_sidebars Re-wording in docs/workflows (#135) 2022-09-13 15:12:05 +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 Re-wording in docs/workflows (#135) 2022-09-13 15:12:05 +02:00
versions.json Ref/docs 2.0 (#112) 2022-09-09 17:01:57 +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.