autogen(docs): generate cli docs

ory-bot · ory-bot · commit 9d57e2976cea · 2022-06-10T09:05:41.000Z
diff --git a/docs/oathkeeper/cli/oathkeeper-credentials-generate.md b/docs/oathkeeper/cli/oathkeeper-credentials-generate.md
@@ -9,7 +9,6 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## oathkeeper credentials generate
 
 Generate a key for the specified algorithm
@@ -18,8 +17,9 @@ Generate a key for the specified algorithm
 
 Examples:
 
-$ oathkeeper credentials generate --alg ES256 &gt; jwks.json $ oathkeeper credentials generate --alg RS256 &gt; jwks.json $
-oathkeeper credentials generate --alg RS256 --bits 4096 &gt; jwks.json
+$ oathkeeper credentials generate --alg ES256 &gt; jwks.json
+$ oathkeeper credentials generate --alg RS256 &gt; jwks.json
+$ oathkeeper credentials generate --alg RS256 --bits 4096 &gt; jwks.json
 
 ```
 oathkeeper credentials generate [flags]
@@ -42,4 +42,5 @@ oathkeeper credentials generate [flags]
 
 ### SEE ALSO
 
-- [oathkeeper credentials](oathkeeper-credentials) - Generate RSA, ECDSA, and other keys and output them as JSON Web Keys
+* [oathkeeper credentials](oathkeeper-credentials)	 - Generate RSA, ECDSA, and other keys and output them as JSON Web Keys
+
diff --git a/docs/oathkeeper/cli/oathkeeper-credentials.md b/docs/oathkeeper/cli/oathkeeper-credentials.md
@@ -9,7 +9,6 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## oathkeeper credentials
 
 Generate RSA, ECDSA, and other keys and output them as JSON Web Keys
@@ -28,5 +27,6 @@ Generate RSA, ECDSA, and other keys and output them as JSON Web Keys
 
 ### SEE ALSO
 
-- [oathkeeper](oathkeeper) - A cloud native Access and Identity Proxy
-- [oathkeeper credentials generate](oathkeeper-credentials-generate) - Generate a key for the specified algorithm
+* [oathkeeper](oathkeeper)	 - A cloud native Access and Identity Proxy
+* [oathkeeper credentials generate](oathkeeper-credentials-generate)	 - Generate a key for the specified algorithm
+
diff --git a/docs/oathkeeper/cli/oathkeeper-health-alive.md b/docs/oathkeeper/cli/oathkeeper-health-alive.md
@@ -9,17 +9,19 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## oathkeeper health alive
 
 Checks if an ORY Oathkeeper deployment is alive
 
 ### Synopsis
 
-Usage example: oathkeeper health --endpoint=http://localhost:4456/ alive
+Usage example:
+  oathkeeper health --endpoint=http://localhost:4456/ alive
+
+Note:
+  The endpoint URL should point to a single ORY Oathkeeper deployment.
+  If the endpoint URL points to a Load Balancer, these commands will effective test the Load Balancer.
 
-Note: The endpoint URL should point to a single ORY Oathkeeper deployment. If the endpoint URL points to a Load Balancer, these
-commands will effective test the Load Balancer.
 
 ```
 oathkeeper health alive [flags]
@@ -40,4 +42,5 @@ oathkeeper health alive [flags]
 
 ### SEE ALSO
 
-- [oathkeeper health](oathkeeper-health) - Commands for checking the status of an ORY Oathkeeper deployment
+* [oathkeeper health](oathkeeper-health)	 - Commands for checking the status of an ORY Oathkeeper deployment
+
diff --git a/docs/oathkeeper/cli/oathkeeper-health-ready.md b/docs/oathkeeper/cli/oathkeeper-health-ready.md
@@ -9,17 +9,19 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## oathkeeper health ready
 
 Checks if an ORY Oathkeeper deployment is ready
 
 ### Synopsis
 
-Usage example: oathkeeper health --endpoint=http://localhost:4456/ ready
+Usage example:
+  oathkeeper health --endpoint=http://localhost:4456/ ready
+
+Note:
+  The endpoint URL should point to a single ORY Oathkeeper deployment.
+  If the endpoint URL points to a Load Balancer, these commands will effective test the Load Balancer.
 
-Note: The endpoint URL should point to a single ORY Oathkeeper deployment. If the endpoint URL points to a Load Balancer, these
-commands will effective test the Load Balancer.
 
 ```
 oathkeeper health ready [flags]
@@ -40,4 +42,5 @@ oathkeeper health ready [flags]
 
 ### SEE ALSO
 
-- [oathkeeper health](oathkeeper-health) - Commands for checking the status of an ORY Oathkeeper deployment
+* [oathkeeper health](oathkeeper-health)	 - Commands for checking the status of an ORY Oathkeeper deployment
+
diff --git a/docs/oathkeeper/cli/oathkeeper-health.md b/docs/oathkeeper/cli/oathkeeper-health.md
@@ -9,15 +9,16 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## oathkeeper health
 
 Commands for checking the status of an ORY Oathkeeper deployment
 
 ### Synopsis
 
-Note: The endpoint URL should point to a single ORY Oathkeeper deployment. If the endpoint URL points to a Load Balancer, these
-commands will effective test the Load Balancer.
+Note:
+  The endpoint URL should point to a single ORY Oathkeeper deployment.
+  If the endpoint URL points to a Load Balancer, these commands will effective test the Load Balancer.
+
 
 ```
 oathkeeper health [flags]
@@ -38,6 +39,7 @@ oathkeeper health [flags]
 
 ### SEE ALSO
 
-- [oathkeeper](oathkeeper) - A cloud native Access and Identity Proxy
-- [oathkeeper health alive](oathkeeper-health-alive) - Checks if an ORY Oathkeeper deployment is alive
-- [oathkeeper health ready](oathkeeper-health-ready) - Checks if an ORY Oathkeeper deployment is ready
+* [oathkeeper](oathkeeper)	 - A cloud native Access and Identity Proxy
+* [oathkeeper health alive](oathkeeper-health-alive)	 - Checks if an ORY Oathkeeper deployment is alive
+* [oathkeeper health ready](oathkeeper-health-ready)	 - Checks if an ORY Oathkeeper deployment is ready
+
diff --git a/docs/oathkeeper/cli/oathkeeper-rules-get.md b/docs/oathkeeper/cli/oathkeeper-rules-get.md
@@ -9,7 +9,6 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## oathkeeper rules get
 
 Get access rule
@@ -18,7 +17,8 @@ Get access rule
 
 Usage example:
 
-    oathkeeper rules --endpoint=http://localhost:4456/ get rule-1
+	oathkeeper rules --endpoint=http://localhost:4456/ get rule-1
+
 
 ```
 oathkeeper rules get &lt;id&gt; [flags]
@@ -39,4 +39,5 @@ oathkeeper rules get &lt;id&gt; [flags]
 
 ### SEE ALSO
 
-- [oathkeeper rules](oathkeeper-rules) - Commands for managing rules
+* [oathkeeper rules](oathkeeper-rules)	 - Commands for managing rules
+
diff --git a/docs/oathkeeper/cli/oathkeeper-rules-list.md b/docs/oathkeeper/cli/oathkeeper-rules-list.md
@@ -9,7 +9,6 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## oathkeeper rules list
 
 List access rules
@@ -18,7 +17,8 @@ List access rules
 
 Usage example:
 
-    oathkeeper rules --endpoint=http://localhost:4456/ list
+	oathkeeper rules --endpoint=http://localhost:4456/ list
+
 
 ```
 oathkeeper rules list [flags]
@@ -41,4 +41,5 @@ oathkeeper rules list [flags]
 
 ### SEE ALSO
 
-- [oathkeeper rules](oathkeeper-rules) - Commands for managing rules
+* [oathkeeper rules](oathkeeper-rules)	 - Commands for managing rules
+
diff --git a/docs/oathkeeper/cli/oathkeeper-rules.md b/docs/oathkeeper/cli/oathkeeper-rules.md
@@ -9,7 +9,6 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## oathkeeper rules
 
 Commands for managing rules
@@ -33,6 +32,7 @@ oathkeeper rules [flags]
 
 ### SEE ALSO
 
-- [oathkeeper](oathkeeper) - A cloud native Access and Identity Proxy
-- [oathkeeper rules get](oathkeeper-rules-get) - Get access rule
-- [oathkeeper rules list](oathkeeper-rules-list) - List access rules
+* [oathkeeper](oathkeeper)	 - A cloud native Access and Identity Proxy
+* [oathkeeper rules get](oathkeeper-rules-get)	 - Get access rule
+* [oathkeeper rules list](oathkeeper-rules-list)	 - List access rules
+
diff --git a/docs/oathkeeper/cli/oathkeeper-serve.md b/docs/oathkeeper/cli/oathkeeper-serve.md
@@ -9,7 +9,6 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## oathkeeper serve
 
 Starts the HTTP/2 REST API and HTTP/2 Reverse Proxy
@@ -20,11 +19,12 @@ Opens two ports for serving both the HTTP/2 Rest API and the HTTP/2 Reverse Prox
 
 ## Configuration
 
-ORY Oathkeeper can be configured using environment variables as well as a configuration file. For more information on
-configuration options, open the configuration documentation:
+ORY Oathkeeper can be configured using environment variables as well as a configuration file. For more information
+on configuration options, open the configuration documentation:
 
 &gt;&gt; https://www.ory.sh/oathkeeper/docs/configuration &lt;&lt;
 
+
 ```
 oathkeeper serve [flags]
 ```
@@ -45,4 +45,5 @@ oathkeeper serve [flags]
 
 ### SEE ALSO
 
-- [oathkeeper](oathkeeper) - A cloud native Access and Identity Proxy
+* [oathkeeper](oathkeeper)	 - A cloud native Access and Identity Proxy
+
diff --git a/docs/oathkeeper/cli/oathkeeper-version.md b/docs/oathkeeper/cli/oathkeeper-version.md
@@ -9,7 +9,6 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## oathkeeper version
 
 Display this binary&#39;s version, build time and git hash of this build
@@ -32,4 +31,5 @@ oathkeeper version [flags]
 
 ### SEE ALSO
 
-- [oathkeeper](oathkeeper) - A cloud native Access and Identity Proxy
+* [oathkeeper](oathkeeper)	 - A cloud native Access and Identity Proxy
+
diff --git a/docs/oathkeeper/cli/oathkeeper.md b/docs/oathkeeper/cli/oathkeeper.md
@@ -9,7 +9,6 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## oathkeeper
 
 A cloud native Access and Identity Proxy
@@ -23,8 +22,9 @@ A cloud native Access and Identity Proxy
 
 ### SEE ALSO
 
-- [oathkeeper credentials](oathkeeper-credentials) - Generate RSA, ECDSA, and other keys and output them as JSON Web Keys
-- [oathkeeper health](oathkeeper-health) - Commands for checking the status of an ORY Oathkeeper deployment
-- [oathkeeper rules](oathkeeper-rules) - Commands for managing rules
-- [oathkeeper serve](oathkeeper-serve) - Starts the HTTP/2 REST API and HTTP/2 Reverse Proxy
-- [oathkeeper version](oathkeeper-version) - Display this binary&#39;s version, build time and git hash of this build
+* [oathkeeper credentials](oathkeeper-credentials)	 - Generate RSA, ECDSA, and other keys and output them as JSON Web Keys
+* [oathkeeper health](oathkeeper-health)	 - Commands for checking the status of an ORY Oathkeeper deployment
+* [oathkeeper rules](oathkeeper-rules)	 - Commands for managing rules
+* [oathkeeper serve](oathkeeper-serve)	 - Starts the HTTP/2 REST API and HTTP/2 Reverse Proxy
+* [oathkeeper version](oathkeeper-version)	 - Display this binary&#39;s version, build time and git hash of this build
+
