Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-01-28 16:27:01 -05:00
Code Issues Packages Projects Releases Wiki Activity
constellation/docs
History
Moritz Sanft 25b23689ad
cli: generate state file during constellation config generate (#2455) 
* create state file during config generate

* use written file in `constellation create`

* document creation of state file

* remove accidentally added test

* check error when writing state file
2023-10-16 20:18:59 +02:00
..
docs
cli: generate state file during constellation config generate (#2455)
2023-10-16 20:18:59 +02:00
screencasts
deps: update ubuntu:22.04 Docker digest to 9b8dec3 (#2432)
2023-10-11 13:43:27 +02:00
src
docs: embedd asciinema casts (#1154)
2023-03-11 00:13:32 +01:00
static
docs: update screencasts to demo node groups (#2243)
2023-08-16 13:50:31 +02:00
styles
s3proxy: add new page to documentation (#2417)
2023-10-10 15:35:23 +02:00
versioned_docs
docs: add s3proxy to features
2023-10-13 11:39:49 +02:00
versioned_sidebars
s3proxy: add new page to documentation (v2.12)
2023-10-10 18:31:02 +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: switch to native mermaid support (#2306)
2023-09-05 11:24:20 +02:00
package.json
docs: switch to native mermaid support (#2306)
2023-09-05 11:24:20 +02:00
README.md
AB#2685 Add documentation for automatic IAM creation (#711)
2022-12-12 13:33:19 +01:00
sidebars.js
s3proxy: add new page to documentation (v2.12)
2023-10-10 18:31:02 +02:00
versions.json
docs: add release v2.12.0
2023-10-10 18:31:02 +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 and choose the "Next" version in the top right.

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.