mirror of https://github.com/edgelesssys/constellation.git synced 2025-01-25 14:56:18 -05:00

History

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.

2024-12-12 09:45:24 +01:00

docs

docs: correct STACKIT IDs (#3545 )

2024-12-12 09:45:24 +01:00

screencasts

deps: update ubuntu:22.04 Docker digest to 0e5e4a5 (#3447 )

2024-11-11 10:11:51 +01:00

src

docs: update docusaurus and enable broken anchor detection

2024-08-23 22:45:37 +02:00

static

docs: refactor gtag

2024-11-22 17:19:51 +01:00

styles

docs: update azure firmware with openhcl (#3473 )

2024-11-11 12:50:18 +01:00

versioned_docs

docs: correct STACKIT IDs (#3545 )

2024-12-12 09:45:24 +01:00

versioned_sidebars

Post v2.20.0 release updates to main (#3525 )

2024-12-04 08:30:14 +01:00

.gitignore

Pin crane and npm dependencies (#3477 )

2024-11-20 18:34:25 +01:00

babel.config.js

Add docs to repo (#38 )

2022-09-02 11:52:42 +02:00

docusaurus.config.js

docs: refactor gtag

2024-11-22 17:19:51 +01:00

package-lock.json

docs: refactor gtag

2024-11-22 17:19:51 +01:00

package.json

docs: refactor gtag

2024-11-22 17:19:51 +01:00

README.md

Pin crane and npm dependencies (#3477 )

2024-11-20 18:34:25 +01:00

sidebars.js

docs: how to reproduce released artifacts (#3451 )

2024-10-29 14:04:59 +01:00

versions.json

Post v2.20.0 release updates to main (#3525 )

2024-12-04 08:30:14 +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 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

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.