autogen(docs): generate and format documentation

ory · May 28, 2020 · c2bffb1 · c2bffb1
1 parent b15fa00
commit c2bffb1
Show file tree

Hide file tree

Showing 11 changed files with 200 additions and 345 deletions.
diff --git a/docs/docs/configure-deploy.md b/docs/docs/configure-deploy.md
@@ -66,7 +66,7 @@ $ export DSN=postgres://keto:secret@ory-keto-example--postgres:5432/keto?sslmode
 $ docker run -it --rm \
   --network ketoguide \
   -e DSN=$DSN \
-  oryd/keto:v0.5.4-alpha.1 \
+  oryd/keto:v0.5.5-alpha.1 \
   migrate sql -e
 
 Applying `client` SQL migrations...
@@ -79,7 +79,7 @@ $ docker run -d \
   --network ketoguide \
   -p 4466:4466 \
   -e DSN=$DSN \
-  oryd/keto:v0.5.4-alpha.1 \
+  oryd/keto:v0.5.5-alpha.1 \
   serve
 ```
 
@@ -120,7 +120,7 @@ $ docker run -it --rm \
   --network ketoguide \
   -v $(pwd)/policies:/policies \
   -e KETO_URL=http://ory-keto-example--keto:4466/ \
-  oryd/keto:v0.5.4-alpha.1 \
+  oryd/keto:v0.5.5-alpha.1 \
   engines acp ory policies import exact /policies/example-policy.json
 ```
 
@@ -130,7 +130,7 @@ Check if the policy has been created:
 $ docker run -it --rm \
   --network ketoguide \
   -e KETO_URL=http://ory-keto-example--keto:4466/ \
-  oryd/keto:v0.5.4-alpha.1 \
+  oryd/keto:v0.5.5-alpha.1 \
   engines acp ory policies get exact example-policy
 {
   "actions": [
@@ -145,7 +145,7 @@ Check if Alice is allowed to delete the blog post:
 $ docker run -it --rm \
   --network ketoguide \
   -e KETO_URL=http://ory-keto-example--keto:4466/ \
-  oryd/keto:v0.5.4-alpha.1 \
+  oryd/keto:v0.5.5-alpha.1 \
   engines acp ory allowed exact alice blog_posts:my-first-blog-post delete
 {
         "allowed": true
@@ -158,7 +158,7 @@ Other users like Bob can not delete it:
 $ docker run -it --rm \
   --network ketoguide \
   -e KETO_URL=http://ory-keto-example--keto:4466/ \
-  oryd/keto:v0.5.4-alpha.1 \
+  oryd/keto:v0.5.5-alpha.1 \
   engines acp ory allowed exact bob blog_posts:my-first-blog-post delete
 {
         "allowed": false

diff --git a/docs/docs/install.md b/docs/docs/install.md
@@ -11,8 +11,8 @@ binaries, Docker images, and support a number of package managers.
 We recommend using Docker to run ORY Keto:
 
 ```shell
-$ docker pull oryd/keto:v0.4.4-alpha.1
-$ docker run --rm -it oryd/keto:v0.4.4-alpha.1 help
+$ docker pull oryd/keto:v0.5.5-alpha.1
+$ docker run --rm -it oryd/keto:v0.5.5-alpha.1 help
 ```
 
 ## macOS
@@ -31,7 +31,7 @@ On linux, you can use `bash <(curl ...)` to fetch the latest stable binary
 using:
 
 ```shell
-$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.4.4-alpha.1
+$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.5.5-alpha.1
 $ ./keto help
 ```
 

diff --git a/docs/docs/reference/api.md b/docs/docs/reference/api.md
diff --git a/docs/docs/reference/configuration.md b/docs/docs/reference/configuration.md
@@ -78,7 +78,7 @@ serve:
   # - Windows Command Line (CMD):
   #    > set SERVE_HOST=<value>
   #
-  host: localhost
+  host: 127.0.0.1
 
   ## Cross Origin Resource Sharing (CORS) ##
   #
@@ -117,9 +117,7 @@ serve:
     #    > set SERVE_CORS_ALLOWED_ORIGINS=<value>
     #
     allowed_origins:
-      - https://example.com
-      - https://*.example.com
-      - https://*.foo.example.com
+      - '*'
 
     ## Allowed HTTP Methods ##
     #
@@ -134,11 +132,7 @@ serve:
     #    > set SERVE_CORS_ALLOWED_METHODS=<value>
     #
     allowed_methods:
-      - PUT
-      - POST
-      - GET
-      - TRACE
-      - DELETE
+      - HEAD
 
     ## Allowed Request HTTP Headers ##
     #
@@ -153,11 +147,9 @@ serve:
     #    > set SERVE_CORS_ALLOWED_HEADERS=<value>
     #
     allowed_headers:
-      - officia aliqua
-      - irure
-      - Duis irure aliqua aute
-      - Duis officia sed dolor irure
-      - labore consequat
+      - consequat tempor commodo dolore incididunt
+      - dolore in
+      - incididunt et Duis
 
     ## Allowed Response HTTP Headers ##
     #
@@ -172,10 +164,10 @@ serve:
     #    > set SERVE_CORS_EXPOSED_HEADERS=<value>
     #
     exposed_headers:
-      - in proident Duis exercitation pariatur
-      - nostrud
-      - commodo Ut
-      - do adipisicing
+      - ad fugiat irure voluptate
+      - pariatur esse anim sed
+      - quis in
+      - amet
 
     ## Allow HTTP Credentials ##
     #
@@ -201,7 +193,7 @@ serve:
     # - Windows Command Line (CMD):
     #    > set SERVE_CORS_MAX_AGE=<value>
     #
-    max_age: 36592762
+    max_age: 82288709
 
     ## Enable Debugging ##
     #
@@ -278,7 +270,7 @@ serve:
 # - Windows Command Line (CMD):
 #    > set PROFILING=<value>
 #
-profiling: cpu
+profiling: ''
 
 ## Log ##
 #
@@ -297,7 +289,7 @@ log:
   # - Windows Command Line (CMD):
   #    > set LOG_LEVEL=<value>
   #
-  level: error
+  level: debug
 
   ## Format ##
   #
@@ -311,7 +303,7 @@ log:
   # - Windows Command Line (CMD):
   #    > set LOG_FORMAT=<value>
   #
-  format: json
+  format: text
 
 ## tracing ##
 #

diff --git a/docs/versioned_docs/version-v0.5/configure-deploy.md b/docs/versioned_docs/version-v0.5/configure-deploy.md
@@ -66,7 +66,7 @@ $ export DSN=postgres://keto:secret@ory-keto-example--postgres:5432/keto?sslmode
 $ docker run -it --rm \
   --network ketoguide \
   -e DSN=$DSN \
-  oryd/keto:v0.5.4-alpha.1 \
+  oryd/keto:v0.5.5-alpha.1 \
   migrate sql -e
 
 Applying `client` SQL migrations...
@@ -79,7 +79,7 @@ $ docker run -d \
   --network ketoguide \
   -p 4466:4466 \
   -e DSN=$DSN \
-  oryd/keto:v0.5.4-alpha.1 \
+  oryd/keto:v0.5.5-alpha.1 \
   serve
 ```
 
@@ -120,7 +120,7 @@ $ docker run -it --rm \
   --network ketoguide \
   -v $(pwd)/policies:/policies \
   -e KETO_URL=http://ory-keto-example--keto:4466/ \
-  oryd/keto:v0.5.4-alpha.1 \
+  oryd/keto:v0.5.5-alpha.1 \
   engines acp ory policies import exact /policies/example-policy.json
 ```
 
@@ -130,7 +130,7 @@ Check if the policy has been created:
 $ docker run -it --rm \
   --network ketoguide \
   -e KETO_URL=http://ory-keto-example--keto:4466/ \
-  oryd/keto:v0.5.4-alpha.1 \
+  oryd/keto:v0.5.5-alpha.1 \
   engines acp ory policies get exact example-policy
 {
   "actions": [
@@ -145,7 +145,7 @@ Check if Alice is allowed to delete the blog post:
 $ docker run -it --rm \
   --network ketoguide \
   -e KETO_URL=http://ory-keto-example--keto:4466/ \
-  oryd/keto:v0.5.4-alpha.1 \
+  oryd/keto:v0.5.5-alpha.1 \
   engines acp ory allowed exact alice blog_posts:my-first-blog-post delete
 {
         "allowed": true
@@ -158,7 +158,7 @@ Other users like Bob can not delete it:
 $ docker run -it --rm \
   --network ketoguide \
   -e KETO_URL=http://ory-keto-example--keto:4466/ \
-  oryd/keto:v0.5.4-alpha.1 \
+  oryd/keto:v0.5.5-alpha.1 \
   engines acp ory allowed exact bob blog_posts:my-first-blog-post delete
 {
         "allowed": false

diff --git a/docs/versioned_docs/version-v0.5/install.md b/docs/versioned_docs/version-v0.5/install.md
@@ -11,8 +11,8 @@ binaries, Docker images, and support a number of package managers.
 We recommend using Docker to run ORY Keto:
 
 ```shell
-$ docker pull oryd/keto:v0.5.4-alpha.1
-$ docker run --rm -it oryd/keto:v0.5.4-alpha.1 help
+$ docker pull oryd/keto:v0.5.5-alpha.1
+$ docker run --rm -it oryd/keto:v0.5.5-alpha.1 help
 ```
 
 ## macOS
@@ -27,10 +27,11 @@ $ keto help
 
 ## Linux
 
-On linux, you can use `curl | bash` to fetch the latest stable binary using:
+On linux, you can use `bash <(curl ...)` to fetch the latest stable binary
+using:
 
 ```shell
-$ curl https://raw.githubusercontent.com/ory/keto/master/install.sh | bash -s -- -b .
+$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.5.5-alpha.1
 $ ./keto help
 ```