mirror of
https://github.com/edgelesssys/constellation.git
synced 2025-01-11 15:39:33 -05:00
1495a7f6dd
We got OpenStack and STACKIT IDs mixed up in our documentation previously. The OpenStack project ID is required in the `clouds.yaml` file, while the STACKIT project ID is required in the Constellation config. This fixes the warning for the OpenStack project ID in `clouds.yaml`, and adds an additional warning for the STACKIT project ID in the configuration section. |
||
|---|---|---|
| .. | ||
| docs | ||
| screencasts | ||
| src | ||
| static | ||
| styles | ||
| versioned_docs | ||
| versioned_sidebars | ||
| .gitignore | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| versions.json | ||
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 ci # Install pinned dependencies
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.XWhen 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.