autogen(docs): generate and format documentation

docs/docs/contributing.md

@@ -86,7 +86,8 @@ Please follow these guidelines when formatting source code:
 Please provide documentation when changing, removing, or adding features.
 Documentation resides in the project's `docs` folder.
 
-In cases where a project does not have a `docs` folder check the README for instructions.
+In cases where a project does not have a `docs` folder check the README for
+instructions.
 
 The commands listed below work exclusively for projects with a `docs` folder
 
@@ -108,8 +109,8 @@ To start a local development server with hot reloading, run:
 $ npm start
 ```
 
-This command opens up a browser window. Please note that changes to the sidebar are not hot-reloaded
-and require a restart of the command.
+This command opens up a browser window. Please note that changes to the sidebar
+are not hot-reloaded and require a restart of the command.
 
 #### Build
 
@@ -146,27 +147,32 @@ please include a note in your commit message explaining why.
 
 ## How We Organize Our Work
 
-All repositories in the [ORY organization](https://github.com/ory) have their issues and pull requests
-monitored in the [ORY Monitoring Board](https://github.com/orgs/ory/projects/9). This allows
-for a transparent backlog of unanswered issues and pull requests across the ecosystem from those
-who are allowed to merge pull requests to the main branch.
+All repositories in the [ORY organization](https://github.com/ory) have their
+issues and pull requests monitored in the
+[ORY Monitoring Board](https://github.com/orgs/ory/projects/9). This allows for
+a transparent backlog of unanswered issues and pull requests across the
+ecosystem from those who are allowed to merge pull requests to the main branch.
 
 The process is as follows:
 
-1. _Cards_ represent open issues and pull requests and are automatically assigned to the **Triage** column if
-   the author is not one of the maintainers and no maintainer has answered yet.
-2. A maintainer assigns the issue or pull request to someone or adds the label _help wanted_
-   which moves the card to **Requires Action**.
-3. If a maintainer leaves a comment or review, the card moves to **Pending Reply**, implying that
-   the original author needs to do something (e.g. implement a change, explain something in more detail, ...).
-4. If a non-maintainer pushes changes to the pull request or leaves a comment, the card moves
-   back to **Requires Action**.
-5. If a card stays inactive for 60 days or more days, we assume that public interest in the issue
-   or change has waned, **archiving** the card.
-6. If the issue is closed or the pull request merged or closed, the card is **archived** as well.
-
-We try our best to answer all issues and review all pull requests and hope that this transparent way
-of keeping a backlog helps you better understand how heavy the workload is.
+1. _Cards_ represent open issues and pull requests and are automatically
+   assigned to the **Triage** column if the author is not one of the maintainers
+   and no maintainer has answered yet.
+2. A maintainer assigns the issue or pull request to someone or adds the label
+   _help wanted_ which moves the card to **Requires Action**.
+3. If a maintainer leaves a comment or review, the card moves to **Pending
+   Reply**, implying that the original author needs to do something (e.g.
+   implement a change, explain something in more detail, ...).
+4. If a non-maintainer pushes changes to the pull request or leaves a comment,
+   the card moves back to **Requires Action**.
+5. If a card stays inactive for 60 days or more days, we assume that public
+   interest in the issue or change has waned, **archiving** the card.
+6. If the issue is closed or the pull request merged or closed, the card is
+   **archived** as well.
+
+We try our best to answer all issues and review all pull requests and hope that
+this transparent way of keeping a backlog helps you better understand how heavy
+the workload is.
 
 ## Communication
 

docs/docs/milestones.md

@@ -13,23 +13,30 @@ Something is not working.
 
 #### Issues
 
-- [ ] Slash (/) in role or policy id causes 404 error for GET and DELETE ([keto#140](https://github.com/ory/keto/issues/140))
-- [ ] Keto is posting plain text passwords when there is an issue with DSN ([keto#237](https://github.com/ory/keto/issues/237))
+- [ ] Slash (/) in role or policy id causes 404 error for GET and DELETE
+      ([keto#140](https://github.com/ory/keto/issues/140))
+- [ ] Keto is posting plain text passwords when there is an issue with DSN
+      ([keto#237](https://github.com/ory/keto/issues/237))
 
 ### [Feat](https://github.com/ory/keto/labels/feat)
 
 New feature or request.
 
 #### Issues
 
-- [ ] Evaluate queries needs to get the entire database in cache to works ([keto#187](https://github.com/ory/keto/issues/187))
-- [ ] Roles and Policies Filter by using flavor strategy ([keto#186](https://github.com/ory/keto/issues/186))
-- [x] Add a description attribute to access control policy role ([keto#213](https://github.com/ory/keto/issues/213))
+- [ ] Evaluate queries needs to get the entire database in cache to works
+      ([keto#187](https://github.com/ory/keto/issues/187))
+- [ ] Roles and Policies Filter by using flavor strategy
+      ([keto#186](https://github.com/ory/keto/issues/186))
+- [x] Add a description attribute to access control policy role
+      ([keto#213](https://github.com/ory/keto/issues/213))
 
 ### [Rfc](https://github.com/ory/keto/labels/rfc)
 
 A request for comments to discuss and share ideas.
 
 #### Issues
 
-- [ ] IDs being limited to varchar(64) reduces the usefulness of URNs when you are using them globally ([keto#197](https://github.com/ory/keto/issues/197))
+- [ ] IDs being limited to varchar(64) reduces the usefulness of URNs when you
+      are using them globally
+      ([keto#197](https://github.com/ory/keto/issues/197))

docs/docs/reference/configuration.md

@@ -42,7 +42,7 @@ section.
 # - Windows Command Line (CMD):
 #    > set DSN=<value>
 #
-dsn: mysql://user:password@tcp(host:123)/database
+dsn: memory
 
 ## HTTP REST API ##
 #
@@ -82,7 +82,7 @@ serve:
   # - Windows Command Line (CMD):
   #    > set SERVE_HOST=<value>
   #
-  host: localhost
+  host: ''
 
   ## Cross Origin Resource Sharing (CORS) ##
   #
@@ -121,9 +121,7 @@ serve:
     #    > set SERVE_CORS_ALLOWED_ORIGINS=<value>
     #
     allowed_origins:
-      - https://example.com
-      - https://*.example.com
-      - https://*.foo.example.com
+      - '*'
 
     ## Allowed HTTP Methods ##
     #
@@ -138,10 +136,8 @@ serve:
     #    > set SERVE_CORS_ALLOWED_METHODS=<value>
     #
     allowed_methods:
+      - HEAD
       - PATCH
-      - DELETE
-      - PUT
-      - POST
 
     ## Allowed Request HTTP Headers ##
     #
@@ -156,9 +152,11 @@ serve:
     #    > set SERVE_CORS_ALLOWED_HEADERS=<value>
     #
     allowed_headers:
-      - do
-      - ea irure in enim
-      - sit enim reprehenderit
+      - culpa eiusmod non ipsum ad
+      - ad
+      - sit
+      - consequat est
+      - velit amet in enim ut
 
     ## Allowed Response HTTP Headers ##
     #
@@ -173,9 +171,11 @@ serve:
     #    > set SERVE_CORS_EXPOSED_HEADERS=<value>
     #
     exposed_headers:
-      - est
-      - ex nisi consectetur
-      - ut Ut consectetur
+      - adipisicing fugiat Ut officia irure
+      - in sint est dolore in
+      - dolore sit cupidatat voluptate
+      - laborum
+      - fugiat
 
     ## Allow HTTP Credentials ##
     #
@@ -201,7 +201,7 @@ serve:
     # - Windows Command Line (CMD):
     #    > set SERVE_CORS_MAX_AGE=<value>
     #
-    max_age: -64415231
+    max_age: -10735613
 
     ## Enable Debugging ##
     #
@@ -310,7 +310,7 @@ log:
   # - Windows Command Line (CMD):
   #    > set LOG_LEVEL=<value>
   #
-  level: warn
+  level: info
 
   ## Format ##
   #
@@ -328,7 +328,7 @@ log:
   # - Windows Command Line (CMD):
   #    > set LOG_FORMAT=<value>
   #
-  format: text
+  format: json
 
 ## tracing ##
 #
@@ -443,4 +443,16 @@ tracing:
         #    > set TRACING_PROVIDERS_JAEGER_SAMPLING_SERVER_URL=<value>
         #
         server_url: http://localhost:5778/sampling
+
+## The Keto version this config is written for. ##
+#
+# SemVer according to https://semver.org/ prefixed with `v` as in our releases.
+#
+# Set this value using environment variables on
+# - Linux/macOS:
+#    $ export VERSION=<value>
+# - Windows Command Line (CMD):
+#    > set VERSION=<value>
+#
+version: v6909625.0.0
 ```

docs/docusaurus.config.js

@@ -2,13 +2,12 @@ const config = require('./contrib/config.js')
 const fs = require('fs')
 const admonitions = require('remark-admonitions')
 
-const githubRepoName = config.projectSlug === 'ecosystem'
-  ? 'docs'
-  : config.projectSlug
+const githubRepoName =
+  config.projectSlug === 'ecosystem' ? 'docs' : config.projectSlug
 
 const links = [
   {
-    to: "/",
+    to: '/',
     activeBasePath: `${config.projectSlug}/docs`,
     label: `Docs`,
     position: 'left'
@@ -80,7 +79,9 @@ module.exports = {
       logo: {
         alt: config.projectName,
         src: `img/logo-${config.projectSlug}.svg`,
-        href: `https://www.ory.sh/${config.projectSlug === 'ecosystem' ? '' : config.projectSlug}`
+        href: `https://www.ory.sh/${
+          config.projectSlug === 'ecosystem' ? '' : config.projectSlug
+        }`
       },
       items: links
     },