autogen(docs): generate and format documentation

ory · Aug 23, 2021 · 2f488ab · 2f488ab
1 parent 16787fc
commit 2f488ab
Show file tree

Hide file tree

Showing 30 changed files with 1,769 additions and 1,397 deletions.
diff --git a/docs/docs/.static/api.json b/docs/docs/.static/api.json
@@ -1937,7 +1937,7 @@
       "name": "Apache 2.0"
     },
     "title": "Ory Kratos API",
-    "version": ""
+    "version": "v0.7.2-alpha.1"
   },
   "openapi": "3.0.3",
   "paths": {

diff --git a/docs/docs/guides/zero-trust-iap-proxy-identity-access-proxy.mdx b/docs/docs/guides/zero-trust-iap-proxy-identity-access-proxy.mdx
@@ -34,7 +34,7 @@ Clone the Ory Kratos repository and fetch the latest images:
 ```shell script
 git clone https://github.com/ory/kratos.git
 cd kratos
-git checkout v0.7.1-alpha.1
+git checkout v0.7.2-alpha.1
 
 ```
 

diff --git a/docs/docs/install.md b/docs/docs/install.md
@@ -11,7 +11,7 @@ binaries, Docker images, and support various package managers.
 We recommend using Docker to run Ory Kratos:
 
 ```shell
-$ docker pull oryd/kratos:v0.7.1-alpha.1
+$ docker pull oryd/kratos:v0.7.2-alpha.1
 $ docker run --rm -it oryd/kratos help
 ```
 
@@ -34,7 +34,7 @@ On linux, you can use `bash <(curl ...)` to fetch the latest stable binary
 using:
 
 ```shell
-$ bash <(curl https://raw.githubusercontent.com/ory/kratos/v0.7.1-alpha.1/install.sh) -b . v0.7.1-alpha.1
+$ bash <(curl https://raw.githubusercontent.com/ory/kratos/v0.7.2-alpha.1/install.sh) -b . v0.7.2-alpha.1
 $ ./kratos help
 ```
 

diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx
@@ -127,7 +127,7 @@ Let's clone Ory Kratos and run `docker-compose`:
 ```shell script
 git clone https://github.com/ory/kratos.git
 cd kratos
-git checkout v0.7.1-alpha.1
+git checkout v0.7.2-alpha.1
 
 docker-compose -f quickstart.yml -f quickstart-standalone.yml up --build --force-recreate
 # If you have SELinux, run:
@@ -553,23 +553,23 @@ recovery, head over to the
 #### Configuration
 
 You can find all configuration files used for this quickstart guide in
-[`./contrib/quickstart/kratos`](https://github.com/ory/kratos/tree/v0.7.1-alpha.1/contrib/quickstart/kratos/email-password)
+[`./contrib/quickstart/kratos`](https://github.com/ory/kratos/tree/v0.7.2-alpha.1/contrib/quickstart/kratos/email-password)
 ,
-[`./quickstart.yml`](https://github.com/ory/kratos/blob/v0.7.1-alpha.1/quickstart.yml),
+[`./quickstart.yml`](https://github.com/ory/kratos/blob/v0.7.2-alpha.1/quickstart.yml),
 and
-[`./quickstart-standalone.yml`](https://github.com/ory/kratos/blob/v0.7.1-alpha.1/quickstart-standalone.yml).
+[`./quickstart-standalone.yml`](https://github.com/ory/kratos/blob/v0.7.2-alpha.1/quickstart-standalone.yml).
 To understand what each of those configuration files does, consult the other
 chapters of this documentation.
 
 :::note
 
 To get a minimal version of Ory Kratos running, you need to set configuration
 values for
-[`identity.default_schema_url`](https://github.com/ory/kratos/blob/v0.7.1-alpha.1/contrib/quickstart/kratos/email-password/kratos.yml#L75)
+[`identity.default_schema_url`](https://github.com/ory/kratos/blob/v0.7.2-alpha.1/contrib/quickstart/kratos/email-password/kratos.yml#L75)
 and
-[`DSN`](https://github.com/ory/kratos/blob/v0.7.1-alpha.1/quickstart.yml#L42).
+[`DSN`](https://github.com/ory/kratos/blob/v0.7.2-alpha.1/quickstart.yml#L42).
 You should also configure
-[`selfservice.flows.*.ui_url`](https://github.com/ory/kratos/blob/v0.7.1-alpha.1/contrib/quickstart/kratos/email-password/kratos.yml#L24)
+[`selfservice.flows.*.ui_url`](https://github.com/ory/kratos/blob/v0.7.2-alpha.1/contrib/quickstart/kratos/email-password/kratos.yml#L24)
 or else Kratos will use fallback URLs.
 
 :::

diff --git a/docs/versioned_docs/version-v0.7/.static/api.json b/docs/versioned_docs/version-v0.7/.static/api.json
@@ -937,7 +937,7 @@
             "type": "string"
           },
           "details": {
-            "additionalProperties": true,
+            "additionalProperties": false,
             "description": "Further error details",
             "type": "object"
           },
@@ -2129,9 +2129,9 @@
     },
     "securitySchemes": {
       "oryAccessToken": {
-        "description": "This security mechanism is only applicable when using the [Ory Platform](https://console.ory.sh) by\ncreating an [Ory Personal Access Token](https://www.ory.sh/docs/guides/create-personal-access-token).\nIf you are using the open source version, this security mechanism\nwill not work out of the box as you will need to add a security mechanism yourself.\n",
-        "scheme": "bearer",
-        "type": "http"
+        "in": "header",
+        "name": "Authorization",
+        "type": "apiKey"
       }
     }
   },
@@ -2144,7 +2144,7 @@
       "name": "Apache 2.0"
     },
     "title": "Ory Kratos API",
-    "version": "v0.7.1-alpha.1"
+    "version": "v0.7.2-alpha.1"
   },
   "openapi": "3.0.3",
   "paths": {

diff --git a/docs/versioned_docs/version-v0.7/admin/managing-users-identities.mdx b/docs/versioned_docs/version-v0.7/admin/managing-users-identities.mdx
@@ -8,8 +8,7 @@ import TabItem from '@theme/TabItem'
 
 This document walks you through the administrative identity management in Ory
 Kratos. You should already be familiar with the
-[Identity Schema](../concepts/identity-schema.mdx) before reading this
-guide.
+[Identity Schema](../concepts/identity-schema.mdx) before reading this guide.
 
 ## Creating an Identity
 

diff --git a/docs/versioned_docs/version-v0.7/cli/kratos.md b/docs/versioned_docs/version-v0.7/cli/kratos.md
@@ -22,6 +22,8 @@ To improve this file please make your change against the appropriate "./cmd/*.go
 
 - [kratos courier](kratos-courier) - Commands related to the Ory Kratos message
   courier
+- [kratos hashers](kratos-hashers) - This command contains helpers around
+  hashing
 - [kratos identities](kratos-identities) - Tools to interact with remote
   identities
 - [kratos jsonnet](kratos-jsonnet) - Helpers for linting and formatting JSONNet

diff --git a/docs/versioned_docs/version-v0.7/concepts/credentials/username-email-password.mdx b/docs/versioned_docs/version-v0.7/concepts/credentials/username-email-password.mdx
@@ -69,8 +69,8 @@ hashers:
 To determine the ideal parameters, head over to the
 [setup guide](../../guides/setting-up-password-hashing-parameters).
 
-When a user signs up using this method, the Default Identity Schema (set
-using `identity.default_schema_url`) is used:
+When a user signs up using this method, the Default Identity Schema (set using
+`identity.default_schema_url`) is used:
 
 ```yaml title="path/to/my/kratos/config.yml"
 identity:
@@ -81,8 +81,8 @@ identity:
 ```
 
 If you don't know what that means, please read the
-[Identity Schema Chapter](../../concepts/identity-schema.mdx) in the
-docs' concepts section.
+[Identity Schema Chapter](../../concepts/identity-schema.mdx) in the docs'
+concepts section.
 
 For a complete reference, defaults, and description please check the
 [Configuration Reference](../../reference/configuration.md).

diff --git a/docs/versioned_docs/version-v0.7/concepts/identity-schema.mdx b/docs/versioned_docs/version-v0.7/concepts/identity-schema.mdx
@@ -171,21 +171,12 @@ switch (session.Identity.SchemaID) {
         // ...
 }
 ```
-:::warning
-
-Please keep in mind that the Identity Schema is not a place to store sensitive
-information that should not be visible to the end-user! Users can see traits and
-other data - except credentials - using the `sessions/whoami` endpoint. The
-Identity Schema is not the right place to store data that should be obfuscated
-from the user!
-
-:::
 
 :::warning
 
 Please keep in mind that the Identity Schema is not a place to store sensitive
 information that should not be visible to the end-user! Users can see traits and
-other data - except credentials - using the `/sessions/whoami` endpoint. The
+other data - except credentials - using the `sessions/whoami` endpoint. The
 Identity Schema is not the right place to store data that should be obfuscated
 from the user!
 

diff --git a/docs/versioned_docs/version-v0.7/concepts/index.md b/docs/versioned_docs/version-v0.7/concepts/index.md
@@ -271,7 +271,7 @@ system:
   attached to the profile.
 
 Ory Kratos implements both scenarios by using
-[Identity Schema](./identity-schema.mdx)
+[Identity Schemas](./identity-schema.mdx)
 
 ### Forget passport-js, oidc-client, ...
 

diff --git a/docs/versioned_docs/version-v0.7/concepts/ui-user-interface.md b/docs/versioned_docs/version-v0.7/concepts/ui-user-interface.md
@@ -167,8 +167,8 @@ use for the labels:
 
 #### Node Order and Labels
 
-For all traits, the labels and orders are taken from the Identity Schema. A
-JSON Schema such as
+For all traits, the labels and orders are taken from the Identity Schema. A JSON
+Schema such as
 
 ```json
 {

diff --git a/docs/versioned_docs/version-v0.7/faq.mdx b/docs/versioned_docs/version-v0.7/faq.mdx
@@ -94,7 +94,7 @@ import { Question, FaqTags } from '@theme/Faq'
     make sure it satisfies a specific regex (e.g. only alphanumeric characters)?
   </p>
   <p>
-    <strong>A</strong>: In the identity json schema using{' '}
+    <strong>A</strong>: In the Identity Schema using{' '}
     <a href="https://json-schema.org/understanding-json-schema/reference/string.html#regular-expressions">
       Regular Expressions
     </a>

diff --git a/docs/versioned_docs/version-v0.7/guides/account-activation-email-verification.mdx b/docs/versioned_docs/version-v0.7/guides/account-activation-email-verification.mdx
@@ -8,8 +8,8 @@ title: Setting up Account Activation and E-Mail Verification
 To send emails, you need to [setup the mail courier](../concepts/email-sms.md)
 
 To set up email verification, your
-[Identity Schema](../concepts/identity-schema.mdx) must have an email
-in its traits and add
+[Identity Schema](../concepts/identity-schema.mdx) must have an email in its
+traits and add
 
 ```json
 {

diff --git a/docs/versioned_docs/version-v0.7/guides/account-recovery-password-reset.mdx b/docs/versioned_docs/version-v0.7/guides/account-recovery-password-reset.mdx
@@ -4,8 +4,8 @@ title: Setting up Account Recovery and Password Reset
 ---
 
 To set up account recovery, your
-[Identity Schema](../concepts/identity-schema.mdx) must have an email
-in its traits and add
+[Identity Schema](../concepts/identity-schema.mdx) must have an email in its
+traits and add
 
 ```json
 {

diff --git a/docs/versioned_docs/version-v0.7/guides/docker.md b/docs/versioned_docs/version-v0.7/guides/docker.md
@@ -52,8 +52,7 @@ verify signatures and encrypt things:
 
 ### Volumes
 
-If the file `$HOME/.kratos.yaml` exists, it will be used as the configuration
-file. The provided Kratos Docker images currently do not include a default
+The provided Kratos Docker images currently do not include a default
 configuration file, but make it easy to pass in your own configuration file(s)
 by either binding a local directory or by creating your own custom Docker Image
 and adding the configuration file(s) to the custom image.
@@ -85,6 +84,11 @@ FROM oryd/kratos:latest
 COPY contrib/quickstart/kratos/email-password/kratos.yml /home/ory
 ```
 
+**Note that in both cases**, you must supply the location of the configuration
+file using the `--config` flag when running the container.
+
+`$ docker run <theimage> --config /home/ory/kratos.yml`
+
 ### Examples
 
 Below you find different examples how to use the official Kratos Docker images.
diff --git a/...rsioned_docs/version-v0.7/guides/zero-trust-iap-proxy-identity-access-proxy.mdx b/...rsioned_docs/version-v0.7/guides/zero-trust-iap-proxy-identity-access-proxy.mdx
@@ -34,7 +34,7 @@ Clone the Ory Kratos repository and fetch the latest images:
 ```shell script
 git clone https://github.com/ory/kratos.git
 cd kratos
-git checkout v0.7.1-alpha.1
+git checkout v0.7.2-alpha.1
 
 ```
 

diff --git a/docs/versioned_docs/version-v0.7/install.md b/docs/versioned_docs/version-v0.7/install.md
@@ -11,7 +11,7 @@ binaries, Docker images, and support various package managers.
 We recommend using Docker to run Ory Kratos:
 
 ```shell
-$ docker pull oryd/kratos:v0.7.1-alpha.1
+$ docker pull oryd/kratos:v0.7.2-alpha.1
 $ docker run --rm -it oryd/kratos help
 ```
 
@@ -34,7 +34,7 @@ On linux, you can use `bash <(curl ...)` to fetch the latest stable binary
 using:
 
 ```shell
-$ bash <(curl https://raw.githubusercontent.com/ory/kratos/v0.7.1-alpha.1/install.sh) -b . v0.7.1-alpha.1
+$ bash <(curl https://raw.githubusercontent.com/ory/kratos/v0.7.2-alpha.1/install.sh) -b . v0.7.2-alpha.1
 $ ./kratos help
 ```