Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-07-11 17:39:26 -04:00
Code Issues Projects Releases Packages Wiki Activity
constellation/docs
History
renovate[bot] e5ead09801
deps: update ubuntu:22.04 Docker digest to 2b7412e (#2496) 
Co-authored-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
2023-10-20 18:22:34 +02:00
..
docs cli: generate state file during constellation config generate (#2455) 2023-10-16 20:18:59 +02:00
screencasts deps: update ubuntu:22.04 Docker digest to 2b7412e (#2496) 2023-10-20 18:22:34 +02:00
src
static
styles
versioned_docs docs: add s3proxy to features 2023-10-13 11:39:49 +02:00
versioned_sidebars s3proxy: add new page to documentation (v2.12) 2023-10-10 18:31:02 +02:00
.gitignore
babel.config.js
docusaurus.config.js Update link to our blog 2023-10-20 12:13:18 +02:00
package.json
README.md
sidebars.js s3proxy: add new page to documentation (v2.12) 2023-10-10 18:31:02 +02:00
versions.json

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.