autogen(docs): generate and format documentation

ory · Mar 25, 2021 · ec93526 · ec93526
1 parent 01af32f
commit ec93526
Show file tree

Hide file tree

Showing 124 changed files with 20,512 additions and 26,691 deletions.
diff --git a/docs/docs/configure-deploy.mdx b/docs/docs/configure-deploy.mdx
@@ -76,11 +76,11 @@ $ export SECRETS_SYSTEM=$(export LC_CTYPE=C; cat /dev/urandom | tr -dc 'a-zA-Z0-
 $ export DSN=postgres://hydra:secret@ory-hydra-example--postgres:5432/hydra?sslmode=disable
 
 # Before starting, let's pull the latest ORY Hydra tag from docker.
-$ docker pull oryd/hydra:v1.9.3-pre.5
+$ docker pull oryd/hydra:v1.10.1-pre.2
 
 # This command will show you all the environment variables that you can set. Read this carefully.
 # It is the equivalent to `hydra help serve`.
-$ docker run -it --rm --entrypoint hydra oryd/hydra:v1.9.3-pre.5 help serve
+$ docker run -it --rm --entrypoint hydra oryd/hydra:v1.10.1-pre.2 help serve
 
 Starts all HTTP/2 APIs and connects to a database backend.
 [...]
@@ -90,7 +90,7 @@ Starts all HTTP/2 APIs and connects to a database backend.
 # It is the equivalent to `hydra migrate sql --yes postgres://hydra:secret@ory-hydra-example--postgres:5432/hydra?sslmode=disable`
 $ docker run -it --rm \
  --network hydraguide \
- oryd/hydra:v1.9.3-pre.5 \
+ oryd/hydra:v1.10.1-pre.2 \
  migrate sql --yes $DSN
 
 Applying `client` SQL migrations...
@@ -108,7 +108,7 @@ $ docker run -d \
  -e URLS_SELF_ISSUER=https://localhost:9000/ \
  -e URLS_CONSENT=http://localhost:9020/consent \
  -e URLS_LOGIN=http://localhost:9020/login \
- oryd/hydra:v1.9.3-pre.5 serve all
+ oryd/hydra:v1.10.1-pre.2 serve all
 
 # And check if it's running:
 $ docker logs ory-hydra-example--hydra
@@ -159,7 +159,7 @@ mount it in the container. For example:
 ```shell
 $ docker run -d \
  -v $(pwd)/hydra.yaml:/hydra.yaml \
- oryd/hydra:v1.9.3-pre.5 serve all --config /hydra.yaml
+ oryd/hydra:v1.10.1-pre.2 serve all --config /hydra.yaml
 ```
 
 :::
@@ -194,7 +194,7 @@ ORY Hydra can be managed using the Hydra Command Line Interface (CLI), which is
 using ORY Hydra's REST APIs. To see the available commands, run:
 
 ```shell
-$ docker run --rm -it --entrypoint hydra oryd/hydra:v1.9.3-pre.5 help
+$ docker run --rm -it --entrypoint hydra oryd/hydra:v1.10.1-pre.2 help
 Hydra is a cloud native high throughput OAuth2 and OpenID Connect provider
 
 Usage:
@@ -253,7 +253,7 @@ URLs the client may request:
 $ docker run --rm -it \
  -e HYDRA_ADMIN_URL=https://ory-hydra-example--hydra:4445 \
  --network hydraguide \
- oryd/hydra:v1.9.3-pre.5 \
+ oryd/hydra:v1.10.1-pre.2 \
  clients create --skip-tls-verify \
  --id facebook-photo-backup \
  --secret some-secret \
@@ -300,7 +300,7 @@ for an access token. The same thing happens with this command:
 $ docker run --rm -it \
  --network hydraguide \
  -p 9010:9010 \
- oryd/hydra:v1.9.3-pre.5 \
+ oryd/hydra:v1.10.1-pre.2 \
  token user --skip-tls-verify \
  --port 9010 \
  --auth-url https://localhost:9000/oauth2/auth \

diff --git a/docs/docs/install.md b/docs/docs/install.md
@@ -11,8 +11,8 @@ binaries, Docker Images and support various package managers.
 We recommend using Docker to run ORY Hydra:
 
 ```shell
-$ docker pull oryd/hydra:v1.9.3-pre.5
-$ docker run --rm -it oryd/hydra:v1.9.3-pre.5 help
+$ docker pull oryd/hydra:v1.10.1-pre.2
+$ docker run --rm -it oryd/hydra:v1.10.1-pre.2 help
 ```
 
 ## macOS

diff --git a/docs/docs/reference/api.mdx b/docs/docs/reference/api.mdx
@@ -8531,7 +8531,7 @@ _Volume volume_
 | Name | string | true | none | Name of the volume. |
 | Options | object | true | none | The driver specific options used when creating the volume. |
 | » **additionalProperties** | string | false | none | none |
-| Scope | string | true | none | The level at which the volume exists. Either `global` for cluster-wide,<br/>or `local` for machine level. |
+| Scope | string | true | none | The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level.  |
 | Status | object | false | none | Low-level details about the volume, provided by the volume driver.<br/>Details are returned as a map with key/value pairs:<br/>`{"key":"value","key2":"value2"}`.<br/><br/>The `Status` field is optional, and is omitted if the volume driver<br/>does not support this feature. |
 | UsageData | [VolumeUsageData](#schemavolumeusagedata) | false | none | VolumeUsageData Usage details about the volume. This information is used by the<br/>`GET /system/df` endpoint, and omitted in other endpoints. |