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
5e1c09bdd6
constellation/docs
History
laralaske 1c78d2fde1
update readme banner (#3318) 
* Add files via upload

* Update README.md

* Rename GitHub Banner_Constellation animated.svg to BannerConstellationanimated.svg

* Update README.md

* Delete docs/static/img/banner.svg

* Update BannerConstellationanimated.svg
2024-08-22 12:29:52 +02:00
..
docs docs: sort clouds table alphabetical (#3315) 2024-08-20 10:35:41 +02:00
screencasts deps: update ubuntu:22.04 Docker digest to 340d9b0 (#3252) 2024-08-02 15:05:28 +02:00
src docs: change to inter font (#2989) 2024-03-15 15:38:34 +01:00
static update readme banner (#3318) 2024-08-22 12:29:52 +02:00
styles Rewrite "chain of trust" section (#3066) 2024-05-27 18:21:27 +02:00
versioned_docs docs: sort clouds table alphabetical (#3315) 2024-08-20 10:35:41 +02:00
versioned_sidebars docs: backport to old versions 2024-07-12 09:16:44 +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 deploy preview and some links 2023-11-23 22:43:10 +01: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 docs: move compute benchmarks to own page 2024-07-12 09:16:44 +02:00
versions.json docs: add release v2.17.0 (#3221) 2024-07-03 14:11:59 +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.