Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-01-26 07:16:08 -05:00
Code Issues Packages Projects Releases Wiki Activity
constellation/docs
History
3u13r e0285c122e
todo responsibilities and cleanup (#1837) 
* chore: add TODO responsibilities

* chore: remove not needed TODOs

* chore: remove outdated migrations

* chore: remove resolved goleak exception

* chore: remove not needed cosign env

* config: add link to our Azure snp docs
2023-06-01 12:33:06 +02:00
..
docs
todo responsibilities and cleanup (#1837)
2023-06-01 12:33:06 +02:00
screencasts
deps: update ubuntu:22.04 Docker digest to ca5534a (#1744)
2023-05-05 14:38:11 +02:00
src
docs: embedd asciinema casts (#1154)
2023-03-11 00:13:32 +01:00
static
docs: simplify readme svg (#1418)
2023-03-15 12:11:54 +01:00
styles
docs: add a qemu section (#1724)
2023-05-17 13:21:35 +00:00
versioned_docs
docs: publish
2023-05-23 15:51:46 +02:00
versioned_sidebars
docs: add release v2.7.0 (#1592)
2023-04-05 10:33:16 +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
deps: update dependency prism-react-renderer to v2 (#1824)
2023-05-24 13:30:14 +02:00
package.json
deps: update dependency @cmfcmf/docusaurus-search-local to v1
2023-05-24 13:47:50 +02:00
README.md
AB#2685 Add documentation for automatic IAM creation (#711)
2022-12-12 13:33:19 +01:00
sidebars.js
docs: few fixes and rewording
2023-03-06 10:43:49 +01:00
versions.json
docs: add release v2.7.0 (#1592)
2023-04-05 10:33:16 +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.