Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-09-19 15:56:03 +00:00
Code Issues Packages Projects Releases Wiki Activity
ebb8d7ca96
constellation/docs
History
Felix Schuster ebb8d7ca96
Rewrite install.md and create verify-cli.md (#124) 
* Rewrite install.md and create verify-cli

* Small beautification

* Address review comment

* Shorten examples.md

* Quick brush over examples

* Fix broken links in v2.0

* Fix broken links in v2.0

* fix lint errors

Co-authored-by: Thomas Tendyck <tt@edgeless.systems>
2022-09-12 18:35:12 +02:00
..
docs Rewrite install.md and create verify-cli.md (#124) 2022-09-12 18:35:12 +02:00
src Rewrite install.md and create verify-cli.md (#124) 2022-09-12 18:35:12 +02:00
static Update asciicinema 2022-09-12 16:27:21 +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 promote issues as support channel (#123) 2022-09-12 13:01:50 +02:00
versioned_sidebars Ref/docs 2.0 (#112) 2022-09-09 17:01:57 +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 Rewrite install.md and create verify-cli.md (#124) 2022-09-12 18:35:12 +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 Rewrite install.md and create verify-cli.md (#124) 2022-09-12 18:35:12 +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.