mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-04 05:12:16 +00:00
fix: multiple docs issues (#8244)
# Which Problems Are Solved - `<details>` tag is rendered in some cases in the docs, instead of rendering a detail section which can be expanded - New API V2 and V3 services where not rendered correctly - The plugin which made it possible to integrate external code files and show them on the docs didn't work anymore # How the Problems Are Solved - remove / from details tag, so it is properly rendered - changing link source from tag to auto - Someone already forked the repository and made it available for docusaurus v3, we integrated the forked version --------- Co-authored-by: Stefan Benz <[email protected]>
This commit is contained in:
Fabi
Stefan Benz
+56
-42
@@ -136,21 +136,25 @@ Additional to the standard CRUD methods:
|
||||
- ListAvailableExecutionMethods
|
||||
- ListAvailableExecutionFunctions
|
||||
|
||||
\<details><summary>action_service.proto</summary>
|
||||
<CodeBlock language="protobuf">{ActionServiceProto}</CodeBlock>
|
||||
\</details>
|
||||
<details>
|
||||
<summary>action_service.proto</summary>
|
||||
<CodeBlock language="protobuf">{ActionServiceProto}</CodeBlock>
|
||||
</details>
|
||||
|
||||
\<details><summary>action_target.proto</summary>
|
||||
<CodeBlock language="protobuf">{ActionTargetProto}</CodeBlock>
|
||||
\</details>
|
||||
<details>
|
||||
<summary>action_target.proto</summary>
|
||||
<CodeBlock language="protobuf">{ActionTargetProto}</CodeBlock>
|
||||
</details>
|
||||
|
||||
\<details><summary>action_execution.proto</summary>
|
||||
<CodeBlock language="protobuf">{ActionExecutionProto}</CodeBlock>
|
||||
\</details>
|
||||
<details>
|
||||
<summary>action_execution.proto</summary>
|
||||
<CodeBlock language="protobuf">{ActionExecutionProto}</CodeBlock>
|
||||
</details>
|
||||
|
||||
\<details><summary>action_query.proto</summary>
|
||||
<CodeBlock language="protobuf">{ActionSearchProto}</CodeBlock>
|
||||
\</details>
|
||||
<details>
|
||||
<summary>action_query.proto</summary>
|
||||
<CodeBlock language="protobuf">{ActionSearchProto}</CodeBlock>
|
||||
</details>
|
||||
|
||||
### ZITADELUsers
|
||||
|
||||
@@ -165,29 +169,35 @@ Standard CRUD methods
|
||||
- Standard CRUD and methods for all IDPs
|
||||
- Resources have additional properties for reusability capabilities.
|
||||
|
||||
\<details><summary>idp_service.proto</summary>
|
||||
<CodeBlock language="protobuf">{IDPServiceProto}</CodeBlock>
|
||||
\</details>
|
||||
<details>
|
||||
<summary>idp_service.proto</summary>
|
||||
<CodeBlock language="protobuf">{IDPServiceProto}</CodeBlock>
|
||||
</details>
|
||||
|
||||
\<details><summary>idp.proto</summary>
|
||||
<CodeBlock language="protobuf">{IDPProto}</CodeBlock>
|
||||
\</details>
|
||||
<details>
|
||||
<summary>idp.proto</summary>
|
||||
<CodeBlock language="protobuf">{IDPProto}</CodeBlock>
|
||||
</details>
|
||||
|
||||
\<details><summary>idp_search.proto</summary>
|
||||
<CodeBlock language="protobuf">{IDPSearchProto}</CodeBlock>
|
||||
\</details>
|
||||
<details>
|
||||
<summary>idp_search.proto</summary>
|
||||
<CodeBlock language="protobuf">{IDPSearchProto}</CodeBlock>
|
||||
</details>
|
||||
|
||||
\<details><summary>idp_gitlab.proto</summary>
|
||||
<CodeBlock language="protobuf">{IDPGitLabProto}</CodeBlock>
|
||||
\</details>
|
||||
<details>
|
||||
<summary>idp_gitlab.proto</summary>
|
||||
<CodeBlock language="protobuf">{IDPGitLabProto}</CodeBlock>
|
||||
</details>
|
||||
|
||||
\<details><summary>object.proto</summary>
|
||||
<CodeBlock language="protobuf">{ObjectProto}</CodeBlock>
|
||||
\</details>
|
||||
<details>
|
||||
<summary>object.proto</summary>
|
||||
<CodeBlock language="protobuf">{ObjectProto}</CodeBlock>
|
||||
</details>
|
||||
|
||||
\<details><summary>resource_object.proto</summary>
|
||||
<CodeBlock language="protobuf">{ResourceObjectProto}</CodeBlock>
|
||||
\</details>
|
||||
<details>
|
||||
<summary>resource_object.proto</summary>
|
||||
<CodeBlock language="protobuf">{ResourceObjectProto}</CodeBlock>
|
||||
</details>
|
||||
|
||||
### ZITADELInstances
|
||||
|
||||
@@ -267,21 +277,25 @@ For a full proto example, have a look at the [ZITADELLanguageSettings service](#
|
||||
|
||||
Default language, restricted languages, supported languages
|
||||
|
||||
\<details><summary>language_service.proto</summary>
|
||||
<CodeBlock language="protobuf">{LanguageServiceProto}</CodeBlock>
|
||||
\</details>
|
||||
<details>
|
||||
<summary>language_service.proto</summary>
|
||||
<CodeBlock language="protobuf">{LanguageServiceProto}</CodeBlock>
|
||||
</details>
|
||||
|
||||
\<details><summary>language.proto</summary>
|
||||
<CodeBlock language="protobuf">{LanguageProto}</CodeBlock>
|
||||
\</details>
|
||||
<details>
|
||||
<summary>language.proto</summary>
|
||||
<CodeBlock language="protobuf">{LanguageProto}</CodeBlock>
|
||||
</details>
|
||||
|
||||
\<details><summary>object.proto</summary>
|
||||
<CodeBlock language="protobuf">{ObjectProto}</CodeBlock>
|
||||
\</details>
|
||||
<details>
|
||||
<summary>object.proto</summary>
|
||||
<CodeBlock language="protobuf">{ObjectProto}</CodeBlock>
|
||||
</details>
|
||||
|
||||
\<details><summary>settings_object.proto</summary>
|
||||
<CodeBlock language="protobuf">{SettingsObjectProto}</CodeBlock>
|
||||
\</details>
|
||||
<details>
|
||||
<summary>settings_object.proto</summary>
|
||||
<CodeBlock language="protobuf">{SettingsObjectProto}</CodeBlock>
|
||||
</details>
|
||||
|
||||
### ZITADELTextSettings
|
||||
|
||||
|
||||
@@ -18,9 +18,10 @@ The setup is tested against Docker version 20.10.17 and Docker Compose version v
|
||||
|
||||
By executing the commands below, you will download the following file:
|
||||
|
||||
\<details><summary>docker-compose.yaml</summary>
|
||||
<details>
|
||||
<summary>docker-compose.yaml</summary>
|
||||
<CodeBlock language="yaml">{DockerComposeSource}</CodeBlock>
|
||||
\</details>
|
||||
</details>
|
||||
|
||||
```bash
|
||||
# Download the docker compose example configuration.
|
||||
@@ -41,9 +42,10 @@ docker compose up --detach
|
||||
|
||||
By executing the commands below, you will download the following file:
|
||||
|
||||
\<details><summary>docker-compose-sa.yaml</summary>
|
||||
<details>
|
||||
<summary>docker-compose-sa.yaml</summary>
|
||||
<CodeBlock language="yaml">{DockerComposeSaSource}</CodeBlock>
|
||||
\</details>
|
||||
</details>
|
||||
|
||||
```bash
|
||||
# Download the docker compose example configuration.
|
||||
|
||||
@@ -21,21 +21,26 @@ The setup is tested against Docker version 20.10.17 and Docker Compose version v
|
||||
|
||||
By executing the commands below, you will download the following files:
|
||||
|
||||
\<details><summary>docker-compose.yaml</summary>
|
||||
<details>
|
||||
<summary>docker-compose.yaml</summary>
|
||||
<CodeBlock language="yaml">{DockerComposeSource}</CodeBlock>
|
||||
\</details>
|
||||
\<details><summary>example-traefik.yaml</summary>
|
||||
</details>
|
||||
<details>
|
||||
<summary>example-traefik.yaml</summary>
|
||||
<CodeBlock language="yaml">{ExampleTraefikSource}</CodeBlock>
|
||||
\</details>
|
||||
\<details><summary>example-zitadel-config.yaml</summary>
|
||||
</details>
|
||||
<details>
|
||||
<summary>example-zitadel-config.yaml</summary>
|
||||
<CodeBlock language="yaml">{ExampleZITADELConfigSource}</CodeBlock>
|
||||
\</details>
|
||||
\<details><summary>example-zitadel-secrets.yaml</summary>
|
||||
</details>
|
||||
<details>
|
||||
<summary>example-zitadel-secrets.yaml</summary>
|
||||
<CodeBlock language="yaml">{ExampleZITADELSecretsSource}</CodeBlock>
|
||||
\</details>
|
||||
\<details><summary>example-zitadel-init-steps.yaml</summary>
|
||||
</details>
|
||||
<details>
|
||||
<summary>example-zitadel-init-steps.yaml</summary>
|
||||
<CodeBlock language="yaml">{ExampleZITADELInitStepsSource}</CodeBlock>
|
||||
\</details>
|
||||
</details>
|
||||
|
||||
```bash
|
||||
# Download the docker compose example configuration.
|
||||
|
||||
@@ -8,18 +8,25 @@ The docker compose example mounts the example zitadel configuration files to the
|
||||
|
||||
By executing the commands below, you will download the following files:
|
||||
|
||||
\<details><summary>docker-compose.yaml</summary>
|
||||
<details>
|
||||
<summary>docker-compose.yaml</summary>
|
||||
<CodeBlock language="yaml">{DockerComposeSource}</CodeBlock>
|
||||
\</details>
|
||||
\<details><summary>example-zitadel-config.yaml</summary>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>example-zitadel-config.yaml</summary>
|
||||
<CodeBlock language="yaml">{ExampleZITADELConfigSource}</CodeBlock>
|
||||
\</details>
|
||||
\<details><summary>example-zitadel-secrets.yaml</summary>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>example-zitadel-secrets.yaml</summary>
|
||||
<CodeBlock language="yaml">{ExampleZITADELSecretsSource}</CodeBlock>
|
||||
\</details>
|
||||
\<details><summary>example-zitadel-init-steps.yaml</summary>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>example-zitadel-init-steps.yaml</summary>
|
||||
<CodeBlock language="yaml">{ExampleZITADELInitStepsSource}</CodeBlock>
|
||||
\</details>
|
||||
</details>
|
||||
|
||||
```bash
|
||||
# Download the docker compose example configuration.
|
||||
|
||||
@@ -9,12 +9,15 @@ For a secure installation with Docker Compose, [go to the loadbalancing example]
|
||||
|
||||
By executing the commands below, you will download the following files:
|
||||
|
||||
\<details><summary>example-zitadel-values.yaml</summary>
|
||||
<details>
|
||||
<summary>example-zitadel-values.yaml</summary>
|
||||
<CodeBlock language="yaml">{ExampleZITADELValuesSource}</CodeBlock>
|
||||
\</details>
|
||||
\<details><summary>example-zitadel-values-secrets.yaml</summary>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>example-zitadel-values-secrets.yaml</summary>
|
||||
<CodeBlock language="yaml">{ExampleZITADELValuesSecretsSource}</CodeBlock>
|
||||
\</details>
|
||||
</details>
|
||||
|
||||
```bash
|
||||
# Download and adjust the example configuration file containing standard configuration
|
||||
|
||||
@@ -7,15 +7,20 @@ import ExampleZITADELInitStepsSource from '!!raw-loader!./example-zitadel-init-s
|
||||
|
||||
By executing the commands below, you will download the following files:
|
||||
|
||||
\<details><summary>example-zitadel-config.yaml</summary>
|
||||
<details>
|
||||
<summary>example-zitadel-config.yaml</summary>
|
||||
<CodeBlock language="yaml">{ExampleZITADELConfigSource}</CodeBlock>
|
||||
\</details>
|
||||
\<details><summary>example-zitadel-secrets.yaml</summary>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>example-zitadel-secrets.yaml</summary>
|
||||
<CodeBlock language="yaml">{ExampleZITADELSecretsSource}</CodeBlock>
|
||||
\</details>
|
||||
\<details><summary>example-zitadel-init-steps.yaml</summary>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>example-zitadel-init-steps.yaml</summary>
|
||||
<CodeBlock language="yaml">{ExampleZITADELInitStepsSource}</CodeBlock>
|
||||
\</details>
|
||||
</details>
|
||||
|
||||
```bash
|
||||
# Download and adjust the example configuration file containing standard configuration
|
||||
|
||||
Reference in New Issue
Block a user