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
1c63b65af2
constellation/docs
History
Nils Hanke 1c63b65af2
Document instanceType in first-steps.md (#59) 
Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>
2022-09-08 15:39:53 +02:00
..
docs Document instanceType in first-steps.md (#59) 2022-09-08 15:39:53 +02:00
src Add docs to repo (#38) 2022-09-02 11:52:42 +02:00
static Update asciicinema SVG (now with 3x speed) 2022-09-08 13:38:24 +02:00
styles Re-write Intro/Welcome (#97) 2022-09-08 08:43:40 +02:00
versioned_docs/version-1.5 docs: remove discarded verify feature 2022-09-07 18:16:07 +02:00
versioned_sidebars Add docs to repo (#38) 2022-09-02 11:52:42 +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 Add search functionality to the docs (#90) 2022-09-07 17:57:45 +02:00
package.json Add search functionality to the docs (#90) 2022-09-07 17:57:45 +02:00
README.md Add docs to repo (#38) 2022-09-02 11:52:42 +02:00
sidebars.js Re-write Intro/Welcome (#97) 2022-09-08 08:43:40 +02:00
versions.json Add docs to repo (#38) 2022-09-02 11:52:42 +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.