mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-19 14:12:52 +00:00
94f9ef966f
<!-- Please inform yourself about the contribution guidelines on submitting a PR here: https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md#submit-a-pull-request-pr. Take note of how PR/commit titles should be written and replace the template texts in the sections below. Don't remove any of the sections. It is important that the commit history clearly shows what is changed and why. Important: By submitting a contribution you agree to the terms from our Licensing Policy as described here: https://github.com/zitadel/zitadel/blob/main/LICENSING.md#community-contributions. --> # Which Problems Are Solved Permissions for each manager role are stored in a .yaml file and can't be easily searched in our docs. # How the Problems Are Solved We reference anyways the defaults.yaml file in our docs. The script parses the yaml and produces a markdown table containing all manager roles by manager permissions. # Additional Changes * Updated README with correct production build command # Additional Context --------- Co-authored-by: Florian Forster <[email protected]> Co-authored-by: Livio Spring <[email protected]>
44 lines
1.5 KiB
Markdown
44 lines
1.5 KiB
Markdown
# ZITADEL-Docs
|
|
|
|
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
|
|
|
|
The documentation is part of the ZITADEL monorepo and uses **pnpm** and **Nx** for development and build processes.
|
|
|
|
## Quick Start
|
|
|
|
Run the following commands from the repositorys root directory to install all dependencies needed.
|
|
Using Corepack makes sure you have the pnpm version intalled that is declared in [](../package.json).
|
|
|
|
```bash
|
|
corepack enable
|
|
pnpm install
|
|
```
|
|
|
|
Start a docs server
|
|
|
|
```bash
|
|
# Start development server with live-reloading
|
|
pnpm nx run @zitadel/docs:dev
|
|
|
|
# Or serve a production build
|
|
pnpm nx run @zitadel/docs:prod
|
|
```
|
|
|
|
The site will be available at http://localhost:3100
|
|
|
|
## 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`.
|
|
|
|
If you are introducing new APIs (gRPC), you need to add a new entry to `docusaurus.config.js` under the `plugins` section.
|
|
|
|
## Build Process
|
|
|
|
The documentation build process automatically:
|
|
|
|
1. **Downloads required protoc plugins** - Ensures `protoc-gen-connect-openapi` is available
|
|
2. **Generates gRPC documentation** - Creates API docs from proto files
|
|
3. **Generates API documentation** - Creates OpenAPI specification docs
|
|
4. **Copies configuration files** - Includes configuration examples
|
|
5. **Builds the Docusaurus site** - Generates the final static site
|