Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-01-12 16:09:39 -05:00
Code Issues Packages Projects Releases Wiki Activity
804c173d52
constellation/docs
History
Felix Schuster 2b32b79026
Rewording in "Getting started" (#193) 
* Small changes

* Update docs/docs/getting-started/first-steps.md

Co-authored-by: Nils Hanke <Nirusu@users.noreply.github.com>

* Update docs/docs/getting-started/first-steps.md

Co-authored-by: Nils Hanke <Nirusu@users.noreply.github.com>

* Update docs/versioned_docs/version-2.0/getting-started/first-steps.md

Co-authored-by: Nils Hanke <Nirusu@users.noreply.github.com>

Co-authored-by: Nils Hanke <Nirusu@users.noreply.github.com>
2022-09-26 15:19:09 +02:00
..
docs Rewording in "Getting started" (#193) 2022-09-26 15:19:09 +02:00
src Rewrite install.md and create verify-cli.md (#124) 2022-09-12 18:35:12 +02:00
static Recude speed for asciicinema (#150) 2022-09-14 15:28:33 +02:00
styles Document cluster based autoscaling 2022-09-20 13:41:23 +02:00
versioned_docs/version-2.0 Rewording in "Getting started" (#193) 2022-09-26 15:19:09 +02:00
versioned_sidebars docs: clarify permissions on install page (#184) 2022-09-21 16:58:04 +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 docs: clarify permissions on install page (#184) 2022-09-21 16:58:04 +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.