mirror of
https://github.com/edgelesssys/constellation.git
synced 2025-01-26 23:37:08 -05:00
19ca4e6ec9
* 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>
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
-
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 newversioned_docs/version-[versionName]/
folder. Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved asversioned_sidebars/version-[versionName]-sidebars.json
. Append the new version number toversions.json
.