Skip to content

Commit

Permalink
autogen(docs): generate and format documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr committed Apr 6, 2021
1 parent 18f4c50 commit 52a68fb
Show file tree
Hide file tree
Showing 12 changed files with 23 additions and 20 deletions.
2 changes: 1 addition & 1 deletion docs/docs/guides/expand-api-display-who-has-access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ tree of everyone who has access to that file:

<CodeTabs
sampleId="expand-api-display-access/01-expand-beach"
version="v0.6.0-alpha.1.pre.4"
version="v0.6.0-alpha.1.pre.6"
/>

### Maximum Tree Depth
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guides/list-api-display-objects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ chats, the application uses Keto's list API:

<CodeTabs
sampleId="list-api-display-objects/01-list-PM"
version="v0.6.0-alpha.1.pre.4"
version="v0.6.0-alpha.1.pre.6"
/>

As a response, the application gets the list of all chats the user `PM` is a
Expand All @@ -103,7 +103,7 @@ In our example, a user wants to see who is a member of the `coffee-break` group:

<CodeTabs
sampleId="list-api-display-objects/02-list-coffee-break"
version="master"
version="v0.6.0-alpha.1.pre.6"
/>

## Application Context
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guides/simple-access-check-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,15 +83,15 @@ Try this yourself by first adding the relation tuple using the

<CodeTabs
sampleId="simple-access-check-guide/00-write-direct-access"
version="v0.6.0-alpha.1.pre.4"
version="v0.6.0-alpha.1.pre.6"
/>

Now, we can use the check-API to verify that `john` is allowed to `decypher` the
message:

<CodeTabs
sampleId="simple-access-check-guide/01-check-direct-access"
version="master"
version="v0.6.0-alpha.1.pre.6"
/>

### Indirectly Defined Access
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.6.0-alpha.1.pre.4
$ docker run --rm -it oryd/keto:v0.6.0-alpha.1.pre.4 help
$ docker pull oryd/keto:v0.6.0-alpha.1.pre.6
$ docker run --rm -it oryd/keto:v0.6.0-alpha.1.pre.6 help
```

## macOS
Expand All @@ -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.6.0-alpha.1.pre.4
$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.6.0-alpha.1.pre.6
$ ./keto help
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ video service client would do. In this example we will use the Keto CLI client.
If you want to run the Keto CLI within **Docker**, set the alias

```shell
alias keto="docker run -it --network cat-videos-example_default -e KETO_READ_REMOTE=\"keto:4466\" oryd/keto:v0.6.0-alpha.1.pre.4"
alias keto="docker run -it --network cat-videos-example_default -e KETO_READ_REMOTE=\"keto:4466\" oryd/keto:v0.6.0-alpha.1.pre.6"
```

in your terminal session. Alternatively, you need to set the remote endpoint so
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -677,7 +677,7 @@ namespaces: http://a.aaa
# - Windows Command Line (CMD):
# > set VERSION=<value>
#
version: v0.6.0-alpha.1.pre.4
version: v0.6.0-alpha.1.pre.6

## Data Source Name ##
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ tree of everyone who has access to that file:

<CodeTabs
sampleId="expand-api-display-access/01-expand-beach"
version="v0.6.0-alpha.1.pre.4"
version="v0.6.0-alpha.1.pre.6"
/>

### Maximum Tree Depth
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,10 @@ chats:coffee-break#member@Patrik
The user `PM` now opens the chat application. To display a list of all of `PM`'s
chats, the application uses Keto's list API:

<CodeTabs sampleId="list-api-display-objects/01-list-PM" version="v0.6.0-alpha.1.pre.4" />
<CodeTabs
sampleId="list-api-display-objects/01-list-PM"
version="v0.6.0-alpha.1.pre.6"
/>

As a response, the application gets the list of all chats the user `PM` is a
member of. It can then use the information to build the UI.
Expand All @@ -100,7 +103,7 @@ In our example, a user wants to see who is a member of the `coffee-break` group:

<CodeTabs
sampleId="list-api-display-objects/02-list-coffee-break"
version="master"
version="v0.6.0-alpha.1.pre.6"
/>

## Application Context
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,15 +83,15 @@ Try this yourself by first adding the relation tuple using the

<CodeTabs
sampleId="simple-access-check-guide/00-write-direct-access"
version="v0.6.0-alpha.1.pre.4"
version="v0.6.0-alpha.1.pre.6"
/>

Now, we can use the check-API to verify that `john` is allowed to `decypher` the
message:

<CodeTabs
sampleId="simple-access-check-guide/01-check-direct-access"
version="master"
version="v0.6.0-alpha.1.pre.6"
/>

### Indirectly Defined Access
Expand Down
6 changes: 3 additions & 3 deletions docs/versioned_docs/version-v0.6/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.6.0-alpha.1.pre.4
$ docker run --rm -it oryd/keto:v0.6.0-alpha.1.pre.4 help
$ docker pull oryd/keto:v0.6.0-alpha.1.pre.6
$ docker run --rm -it oryd/keto:v0.6.0-alpha.1.pre.6 help
```

## macOS
Expand All @@ -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.6.0-alpha.1.pre.4
$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.6.0-alpha.1.pre.6
$ ./keto help
```

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-v0.6/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ video service client would do. In this example we will use the Keto CLI client.
If you want to run the Keto CLI within **Docker**, set the alias

```shell
alias keto="docker run -it --network cat-videos-example_default -e KETO_READ_REMOTE=\"keto:4466\" oryd/keto:v0.6.0-alpha.1.pre.4"
alias keto="docker run -it --network cat-videos-example_default -e KETO_READ_REMOTE=\"keto:4466\" oryd/keto:v0.6.0-alpha.1.pre.6"
```

in your terminal session. Alternatively, you need to set the remote endpoint so
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -677,7 +677,7 @@ namespaces: http://a.aaa
# - Windows Command Line (CMD):
# > set VERSION=<value>
#
version: v0.6.0-alpha.1.pre.4
version: v0.6.0-alpha.1.pre.6

## Data Source Name ##
#
Expand Down

0 comments on commit 52a68fb

Please sign in to comment.