fix(docs): autogenerate docs (#8299)

* docs: auto-generated property docs * docs: auto-generated Swagger SPEC docs --------- Co-authored-by: Mohammad Abudayyeh <47318409+moabu@users.noreply.github.com>
JanssenProject · Apr 17, 2024 · d048edc · d048edc
1 parent 7a2800d
commit d048edc
Show file tree

Hide file tree

Showing 20 changed files with 178 additions and 85 deletions.
diff --git a/charts/janssen-all-in-one/README.md b/charts/janssen-all-in-one/README.md
@@ -338,4 +338,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/charts/janssen/README.md b/charts/janssen/README.md
@@ -608,4 +608,4 @@ Kubernetes: `>=v1.22.0-0`
 | scim.volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/charts/janssen/charts/auth-server-key-rotation/README.md b/charts/janssen/charts/auth-server-key-rotation/README.md
@@ -49,4 +49,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/charts/janssen/charts/auth-server/README.md b/charts/janssen/charts/auth-server/README.md
@@ -58,4 +58,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/charts/janssen/charts/casa/README.md b/charts/janssen/charts/casa/README.md
@@ -63,4 +63,4 @@ Kubernetes: `>=v1.21.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/charts/janssen/charts/cn-istio-ingress/README.md b/charts/janssen/charts/cn-istio-ingress/README.md
@@ -22,4 +22,4 @@ Istio Gateway
 Kubernetes: `>=v1.21.0-0`
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/charts/janssen/charts/config-api/README.md b/charts/janssen/charts/config-api/README.md
@@ -62,4 +62,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/charts/janssen/charts/config/README.md b/charts/janssen/charts/config/README.md
@@ -129,4 +129,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/charts/janssen/charts/fido2/README.md b/charts/janssen/charts/fido2/README.md
@@ -59,4 +59,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/charts/janssen/charts/link/README.md b/charts/janssen/charts/link/README.md
@@ -62,4 +62,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/charts/janssen/charts/nginx-ingress/README.md b/charts/janssen/charts/nginx-ingress/README.md
@@ -62,4 +62,4 @@ Kubernetes: `>=v1.22.0-0`
 | nameOverride | string | `""` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/charts/janssen/charts/opendj/README.md b/charts/janssen/charts/opendj/README.md
@@ -71,4 +71,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/charts/janssen/charts/persistence/README.md b/charts/janssen/charts/persistence/README.md
@@ -49,4 +49,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/charts/janssen/charts/saml/README.md b/charts/janssen/charts/saml/README.md
@@ -61,4 +61,4 @@ Kubernetes: `>=v1.21.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/charts/janssen/charts/scim/README.md b/charts/janssen/charts/scim/README.md
@@ -58,4 +58,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/docs/admin/install/docker-install/compose.md b/docs/admin/install/docker-install/compose.md
@@ -7,8 +7,8 @@ tags:
 - docker image
 ---
 
-!!! Warning 
-    **This image is for testing and development purposes only. Use Janssen [helm charts](https://github.com/JanssenProject/jans/tree/main/charts/janssen) for production setups.**
+> **Warning**
+> This image is for testing and development purposes only. Use Janssen [helm charts](https://github.com/JanssenProject/jans/tree/main/charts/janssen) for production setups.
 
 ## Overview
 
@@ -51,7 +51,7 @@ Installation depends on the set of environment variables shown below. These envi
 
 ## How to run
 
-Download the compose file:
+Download the compose file 
 
 ```bash
 
@@ -64,7 +64,7 @@ This docker compose file runs two containers, the janssen monolith container and
 docker compose -f jans-mysql-compose.yml up -d
 ```
 
-To view the containers running:
+To view the containers running
 
 ```bash
 
@@ -73,19 +73,14 @@ docker compose -f jans-mysql-compose.yml ps
 
 ## Configure Janssen Server
 
-1. Access the Docker container shell using:
-
-    ```bash
-    docker compose -f jans-mysql-compose.yml exec jans sh
-    ```
+```bash
 
-2. Grab a pair of client_id and client_pw(secret) from `setup.properties` or `/opt/jans/jans-setup/setup.properties.last`
+docker compose -f jans-mysql-compose.yml exec jans sh #This opens a bash terminal in the running container
 
-3. Use the CLI tools located under `/opt/jans/jans-cli/` to configure Janssen Server as needed. For example you can run the [TUI](../../config-guide/config-tools/jans-tui/README.md):
-    ```bash
-    python3 /opt/jans/jans-cli/config-cli-tui.py
-    ```
+/opt/jans/jans-cli/config-cli.py #configure using the config-cli
 
+/opt/jans/jans-cli/scim-cli.py #configure using the scim-cli
+```
 
 ## Access endpoints externally
 
@@ -105,4 +100,3 @@ Remove setup and volumes
 ```
 docker compose -f jans-mysql-compose.yml down
 ```
-
diff --git a/docs/admin/reference/kubernetes/docker-jans-all-in-one.md b/docs/admin/reference/kubernetes/docker-jans-all-in-one.md
@@ -0,0 +1,3 @@
+# jans-aio
+
+Janssen All-In-One image
diff --git a/docs/admin/reference/kubernetes/docker-jans-monolith.md b/docs/admin/reference/kubernetes/docker-jans-monolith.md
@@ -100,4 +100,3 @@ Remove setup and volumes
 ```
 docker compose -f jans-mysql-compose.yml down
 ```
-