Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-12-24 06:59:40 -05:00
Code Issues Packages Projects Releases Wiki Activity
43924c7318
constellation/docs
History
Fabian Kammel 106635a9ee
Restructure config docs (#44) 
* more guided UX when generating and filling in config
Signed-off-by: Fabian Kammel <fk@edgeless.systems>
2022-09-02 17:11:06 +02:00
..
docs Restructure config docs (#44) 2022-09-02 17:11:06 +02:00
src Add docs to repo (#38) 2022-09-02 11:52:42 +02:00
static Update README (#46) 2022-09-02 16:10:27 +02:00
styles Add docs to repo (#38) 2022-09-02 11:52:42 +02:00
versioned_docs/version-1.5 Restructure config docs (#44) 2022-09-02 17:11:06 +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 docs to repo (#38) 2022-09-02 11:52:42 +02:00
package.json Add docs to repo (#38) 2022-09-02 11:52:42 +02:00
README.md Add docs to repo (#38) 2022-09-02 11:52:42 +02:00
sidebars.js Add docs to repo (#38) 2022-09-02 11:52:42 +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.