mirror of https://github.com/edgelesssys/constellation.git synced 2024-12-25 23:49:37 -05:00

History

Moritz Sanft 19ca4e6ec9 docs: document self-managed infrastructure (#2458 ) * add minimal docs for self-managed infrastructure * Update docs/docs/getting-started/first-steps.md Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com> * Update docs/docs/workflows/create.md Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com> * Update docs/docs/workflows/create.md Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com> * Update docs/docs/workflows/create.md Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com> * default to yq Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * Update docs/docs/workflows/create.md Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com> * don't tie self-managed infrastructure to Terraform * silence the review-dog Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * Update docs/docs/workflows/create.md Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com> * Update docs/docs/workflows/create.md Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com> * Update docs/docs/workflows/create.md Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com> * Update docs/docs/workflows/create.md Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com> * [broken] add docs for filling tfvars file Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * fix docs Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * remove unnecessary linebreaks * add missing value Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * fix quoting Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * document endpoint separation Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> --------- Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com> Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>		2023-10-23 11:53:08 +02:00
..
docs	docs: document self-managed infrastructure (#2458 )	2023-10-23 11:53:08 +02:00
screencasts	deps: update ubuntu:22.04 Docker digest to 2b7412e (#2496 )	2023-10-20 18:22:34 +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	Update link to our blog	2023-10-20 12:13:18 +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

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.