Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-12-23 14:39:40 -05:00
Code Issues Packages Projects Releases Wiki Activity
67a58bcc56
constellation/docs
History
Otto Bittner 67a58bcc56 docs: rename components to microservices 
Since we now have a config value called microserviceVersion
it hopefully makes it easier for users to understand what
this value controls if we also use the term microservice
in the docs.
2023-03-03 15:40:57 +01:00
..
docs docs: rename components to microservices 2023-03-03 15:40:57 +01:00
src Rewrite install.md and create verify-cli.md (#124) 2022-09-12 18:35:12 +02:00
static init: create kubeconfig file with unique user/cluster name (#1133) 2023-02-10 13:27:22 +01:00
styles docs: few fixes and rewording 2022-12-12 14:34:59 +01:00
versioned_docs docs: adjust wording for resource provider troubleshooting 2023-03-01 16:10:06 +01:00
versioned_sidebars docs: generate docs for v2.5.0 (#1059) 2023-01-23 20:13:24 +01: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 Add plausbile to docusaurus (#456) 2022-11-04 14:15:34 +01:00
package.json docs: update dependencies 2022-12-07 10:17:48 +01:00
README.md AB#2685 Add documentation for automatic IAM creation (#711) 2022-12-12 13:33:19 +01:00
sidebars.js docs: rewrite upgrade docs for new commands 2023-03-03 15:40:57 +01:00
versions.json docs: generate docs for v2.5.0 (#1059) 2023-01-23 20:13:24 +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.