mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-04 23:45:07 +00:00
fb481256ec
# Which Problems Are Solved The actions v2 docs have broken links. Also, actions docs are distributed and the navigation feels messy. # How the Problems Are Solved - The two actions v2 docs pages are integrated into the more accurate actions v3 API section. Redirects are added to the Vercel config.   - The broken links are fixed. # Additional Changes A text is added to the actions v3 section describing the changes coming with v3.  # Additional Context - Replaces #8688 - Broken links reported in https://discord.com/channels/927474939156643850/1275551972283646055 - Broken links reported in https://discord.com/channels/927474939156643850/1168451861515354133/1280394234679136267 --------- Co-authored-by: Fabi <fabienne@zitadel.com> |
||
|---|---|---|
| .. | ||
| apis/assets | ||
| docs | ||
| src | ||
| static | ||
| .gitignore | ||
| babel.config.js | ||
| buf.gen.yaml | ||
| docusaurus.config.js | ||
| frameworks.json | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| tailwind.config.js | ||
| vercel.json | ||
| yarn.lock | ||
ZITADEL-Docs
This website is built using Docusaurus 2, a modern static website generator.
Add new Sites to existing Topics
To add a new site to the already existing structure simply save the md file into the corresponding folder and append the sites id int the file sidebars.js.
Installation
Install dependencies with
yarn install
then run
yarn generate
Local Development
Start a local development server with
yarn start
When working on the API docs, run a local development server with
yarn start:api
Container Image
If you just want to start docusaurus locally without installing node you can fallback to our container image. Execute the following commands from the repository root to build and start a local version of ZITADEL
docker build -f docs/Dockerfile . -t zitadel-docs
docker run -p 8080:8080 zitadel-docs