Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-09-20 00:06:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
d5d5ea857d
constellation/docs
History
renovate[bot] dda426a51e
deps: update ubuntu:22.04 Docker digest to a6d2b38 (#3084) 
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-05-13 10:18:56 +02:00
..
docs terraform: add missing policies for AWS ALB (#3063) 2024-05-10 08:51:32 +02:00
screencasts deps: update ubuntu:22.04 Docker digest to a6d2b38 (#3084) 2024-05-13 10:18:56 +02:00
src docs: change to inter font (#2989) 2024-03-15 15:38:34 +01:00
static Small changes in docs/README (#3050) 2024-04-30 16:01:56 +02:00
styles docs: document STACKIT CC features 2024-03-11 16:43:36 +01:00
versioned_docs docs: update images with inter font (#2995) 2024-04-08 07:28:01 +02:00
versioned_sidebars docs: add release v2.16.0 2024-02-29 17:22:19 +01:00
.gitignore
babel.config.js
docusaurus.config.js
package.json
README.md
sidebars.js
versions.json docs: add release v2.16.0 2024-02-29 17:22:19 +01: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.