autogen(docs): generate and format documentation

ory · Dec 2, 2020 · d849bd5 · d849bd5
1 parent b6f49cd
commit d849bd5
Show file tree

Hide file tree

Showing 120 changed files with 527 additions and 36,831 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.0-alpha.2
+$ docker pull oryd/hydra:v1.9.0-alpha.3.pre.1
 
 # 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.0-alpha.2 help serve
+$ docker run -it --rm --entrypoint hydra oryd/hydra:v1.9.0-alpha.3.pre.1 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.0-alpha.2 \
+  oryd/hydra:v1.9.0-alpha.3.pre.1 \
   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.0-alpha.2 serve all
+  oryd/hydra:v1.9.0-alpha.3.pre.1 serve all
 
 # And check if it's running:
 $ docker logs ory-hydra-example--hydra
@@ -176,7 +176,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.0-alpha.2 help
+$ docker run --rm -it --entrypoint hydra oryd/hydra:v1.9.0-alpha.3.pre.1 help
 Hydra is a cloud native high throughput OAuth2 and OpenID Connect provider
 
 Usage:
@@ -235,7 +235,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.0-alpha.2 \
+  oryd/hydra:v1.9.0-alpha.3.pre.1 \
   clients create --skip-tls-verify \
     --id facebook-photo-backup \
     --secret some-secret \
@@ -282,7 +282,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.0-alpha.2 \
+  oryd/hydra:v1.9.0-alpha.3.pre.1 \
   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
@@ -3,16 +3,17 @@ id: install
 title: Installation
 ---
 
-Installing ORY Hydra on any system is straight forward. We prov1.9.0-alpha.2
-pre-built binaries, Docker Images and support v1.9.0-alpha.2 package managers.
+Installing ORY Hydra on any system is straight forward. We
+prov1.9.0-alpha.3.pre.1 pre-built binaries, Docker Images and support
+v1.9.0-alpha.3.pre.1 package managers.
 
 ## Docker
 
 We recommend using Docker to run ORY Hydra:
 
 ```shell
-$ docker pull oryd/hydra:v1.9.0-alpha.2
-$ docker run --rm -it oryd/hydra:v1.9.0-alpha.2 help
+$ docker pull oryd/hydra:v1.9.0-alpha.3.pre.1
+$ docker run --rm -it oryd/hydra:v1.9.0-alpha.3.pre.1 help
 ```
 
 ## macOS
@@ -31,11 +32,11 @@ On linux, you can use `bash <(curl ...)` to fetch the latest stable binary
 using:
 
 ```shell
-$ bash <(curl https://raw.githubusercontent.com/ory/hydra/v1.9.0-alpha.2/install.sh) -b . v1.9.0-alpha.2
+$ bash <(curl https://raw.githubusercontent.com/ory/hydra/v1.9.0-alpha.3.pre.1/install.sh) -b . v1.9.0-alpha.3.pre.1
 $ ./hydra help
 ```
 
-You may want to mov1.9.0-alpha.2 ORY Hydra to your `$PATH`:
+You may want to mov1.9.0-alpha.3.pre.1 ORY Hydra to your `$PATH`:
 
 ```shell
 $ sudo mv ./hydra /usr/local/bin/
@@ -54,16 +55,16 @@ You can install ORY Hydra using [scoop](https://scoop.sh) on Windows:
 
 ## Kubernetes
 
-Please head ov1.9.0-alpha.2 to the
+Please head ov1.9.0-alpha.3.pre.1 to the
 [Kubernetes Helm Chart](guides/kubernetes-helm-chart) documentation.
 
 ## Download Binaries
 
-You can download the client and serv1.9.0-alpha.2 binaries on our
+You can download the client and serv1.9.0-alpha.3.pre.1 binaries on our
 [Github releases](https://github.com/ory/hydra/releases) page. There is
-currently no installer av1.9.0-alpha.2 You hav1.9.0-alpha.2 to add the Hydra
-binary to the PATH in your env1.9.0-alpha.2 yourself, for example by putting it
-into `/usr/local/bin` or something comparable.
+currently no installer av1.9.0-alpha.3.pre.1 You hav1.9.0-alpha.3.pre.1 to add
+the Hydra binary to the PATH in your env1.9.0-alpha.3.pre.1 yourself, for
+example by putting it into `/usr/local/bin` or something comparable.
 
 Once installed, you should be able to run:
 
@@ -77,12 +78,12 @@ If you wish to compile ORY Hydra yourself, you need to install and set up
 [Go 1.12+](https://golang.org/) and add `$GOPATH/bin` to your `$PATH`.
 
 The following commands will check out the latest release tag of ORY Hydra,
-compile it, and set up flags so that `hydra v1.9.0-alpha.2` works as expected.
-Please note that this will only work in a Bash-like shell.
+compile it, and set up flags so that `hydra v1.9.0-alpha.3.pre.1` works as
+expected. Please note that this will only work in a Bash-like shell.
 
 ```shell
 $ go get -d -u github.com/ory/hydra
-$ go install github.com/gobuffalo/packr/v1.9.0-alpha.2/packr2
+$ go install github.com/gobuffalo/packr/v1.9.0-alpha.3.pre.1/packr2
 $ cd $(go env GOPATH)/src/github.com/ory/hydra
 $ GO111MODULE=on make install-stable
 $ $(go env GOPATH)/bin/hydra help