mirror of
https://github.com/edgelesssys/constellation.git
synced 2024-09-07 18:12:01 +00:00
![]() * deps: update Kubernetes versions * deps: tidy all modules --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: edgelessci <edgelessci@users.noreply.github.com> |
||
---|---|---|
.. | ||
docs | ||
screencasts | ||
src | ||
static | ||
styles | ||
versioned_docs | ||
versioned_sidebars | ||
.gitignore | ||
babel.config.js | ||
docusaurus.config.js | ||
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 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
.