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 May 7, 2021
1 parent a3658ba commit ba29af4
Show file tree
Hide file tree
Showing 12 changed files with 32 additions and 32 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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.6.0-alpha.1
git checkout v0.6.0-alpha.2

```

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

Expand All @@ -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.6.0-alpha.1/install.sh) -b . v0.6.0-alpha.1
$ bash <(curl https://raw.githubusercontent.com/ory/kratos/v0.6.0-alpha.2/install.sh) -b . v0.6.0-alpha.2
$ ./kratos help
```

Expand Down
14 changes: 7 additions & 7 deletions docs/docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.6.0-alpha.1
git checkout v0.6.0-alpha.2

docker-compose -f quickstart.yml -f quickstart-standalone.yml up --build --force-recreate
# If you have SELinux, run:
Expand Down Expand Up @@ -552,23 +552,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.6.0-alpha.1/contrib/quickstart/kratos/email-password)
[`./contrib/quickstart/kratos`](https://github.com/ory/kratos/tree/v0.6.0-alpha.2/contrib/quickstart/kratos/email-password)
,
[`./quickstart.yml`](https://github.com/ory/kratos/blob/v0.6.0-alpha.1/quickstart.yml),
[`./quickstart.yml`](https://github.com/ory/kratos/blob/v0.6.0-alpha.2/quickstart.yml),
and
[`./quickstart-standalone.yml`](https://github.com/ory/kratos/blob/v0.6.0-alpha.1/quickstart-standalone.yml).
[`./quickstart-standalone.yml`](https://github.com/ory/kratos/blob/v0.6.0-alpha.2/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.6.0-alpha.1/contrib/quickstart/kratos/email-password/kratos.yml#L75)
[`identity.default_schema_url`](https://github.com/ory/kratos/blob/v0.6.0-alpha.2/contrib/quickstart/kratos/email-password/kratos.yml#L75)
and
[`DSN`](https://github.com/ory/kratos/blob/v0.6.0-alpha.1/quickstart.yml#L42).
[`DSN`](https://github.com/ory/kratos/blob/v0.6.0-alpha.2/quickstart.yml#L42).
You should also configure
[`selfservice.flows.*.ui_url`](https://github.com/ory/kratos/blob/v0.6.0-alpha.1/contrib/quickstart/kratos/email-password/kratos.yml#L24)
[`selfservice.flows.*.ui_url`](https://github.com/ory/kratos/blob/v0.6.0-alpha.2/contrib/quickstart/kratos/email-password/kratos.yml#L24)
or else Kratos will use fallback URLs.

:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.6.0-alpha.1
git checkout v0.6.0-alpha.2

```

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

Expand All @@ -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.6.0-alpha.1/install.sh) -b . v0.6.0-alpha.1
$ bash <(curl https://raw.githubusercontent.com/ory/kratos/v0.6.0-alpha.2/install.sh) -b . v0.6.0-alpha.2
$ ./kratos help
```

Expand Down
6 changes: 3 additions & 3 deletions docs/versioned_docs/version-v0.6/milestones.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,6 @@ Something is not working.

#### Issues

- [ ] Receive the verification email every time when I update my password
([kratos#1221](https://github.com/ory/kratos/issues/1221))
- [ ] Investigate why smtps fails but smtp does not
([kratos#781](https://github.com/ory/kratos/issues/781)) -
[@hackerman](https://github.com/aeneasr)
Expand All @@ -156,6 +154,8 @@ Something is not working.
providers ([kratos#694](https://github.com/ory/kratos/issues/694))
- [x] handle 409 error in settings flow
([kratos#1107](https://github.com/ory/kratos/issues/1107))
- [x] Receive the verification email every time when I update my password
([kratos#1221](https://github.com/ory/kratos/issues/1221))
- [x] No email validation for /verify and /recovery page. email queue is
backlogged with invalid emails.
([kratos#1285](https://github.com/ory/kratos/issues/1285))
Expand Down Expand Up @@ -319,7 +319,7 @@ Blocks milestones or other issues or pulls.

#### Issues

- [ ] Ory Kratos v0.6 pre-release list
- [x] Ory Kratos v0.6 pre-release list
([kratos#1222](https://github.com/ory/kratos/issues/1222)) -
[@hackerman](https://github.com/aeneasr)

Expand Down
14 changes: 7 additions & 7 deletions docs/versioned_docs/version-v0.6/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.6.0-alpha.1
git checkout v0.6.0-alpha.2

docker-compose -f quickstart.yml -f quickstart-standalone.yml up --build --force-recreate
# If you have SELinux, run:
Expand Down Expand Up @@ -552,23 +552,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.6.0-alpha.1/contrib/quickstart/kratos/email-password)
[`./contrib/quickstart/kratos`](https://github.com/ory/kratos/tree/v0.6.0-alpha.2/contrib/quickstart/kratos/email-password)
,
[`./quickstart.yml`](https://github.com/ory/kratos/blob/v0.6.0-alpha.1/quickstart.yml),
[`./quickstart.yml`](https://github.com/ory/kratos/blob/v0.6.0-alpha.2/quickstart.yml),
and
[`./quickstart-standalone.yml`](https://github.com/ory/kratos/blob/v0.6.0-alpha.1/quickstart-standalone.yml).
[`./quickstart-standalone.yml`](https://github.com/ory/kratos/blob/v0.6.0-alpha.2/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.6.0-alpha.1/contrib/quickstart/kratos/email-password/kratos.yml#L75)
[`identity.default_schema_url`](https://github.com/ory/kratos/blob/v0.6.0-alpha.2/contrib/quickstart/kratos/email-password/kratos.yml#L75)
and
[`DSN`](https://github.com/ory/kratos/blob/v0.6.0-alpha.1/quickstart.yml#L42).
[`DSN`](https://github.com/ory/kratos/blob/v0.6.0-alpha.2/quickstart.yml#L42).
You should also configure
[`selfservice.flows.*.ui_url`](https://github.com/ory/kratos/blob/v0.6.0-alpha.1/contrib/quickstart/kratos/email-password/kratos.yml#L24)
[`selfservice.flows.*.ui_url`](https://github.com/ory/kratos/blob/v0.6.0-alpha.2/contrib/quickstart/kratos/email-password/kratos.yml#L24)
or else Kratos will use fallback URLs.

:::
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_sidebars/version-v0.6-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
{
"label": "Bring your own UI",
"type": "link",
"href": "https://www.ory.sh/docs/guides/ui"
"href": "https://www.ory.sh/docs/guides/bring-your-user-interface"
}
]
},
Expand Down
4 changes: 2 additions & 2 deletions quickstart-crdb.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ version: '3.7'

services:
kratos-migrate:
image: oryd/kratos:v0.6.0-alpha.1
image: oryd/kratos:v0.6.0-alpha.2
environment:
- DSN=cockroach://root@cockroachd:26257/defaultdb?sslmode=disable&max_conns=20&max_idle_conns=4

kratos:
image: oryd/kratos:v0.6.0-alpha.1
image: oryd/kratos:v0.6.0-alpha.2
environment:
- DSN=cockroach://root@cockroachd:26257/defaultdb?sslmode=disable&max_conns=20&max_idle_conns=4

Expand Down
4 changes: 2 additions & 2 deletions quickstart-mysql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ version: '3.7'

services:
kratos-migrate:
image: oryd/kratos:v0.6.0-alpha.1
image: oryd/kratos:v0.6.0-alpha.2
environment:
- DSN=mysql://root:secret@tcp(mysqld:3306)/mysql?max_conns=20&max_idle_conns=4

kratos:
image: oryd/kratos:v0.6.0-alpha.1
image: oryd/kratos:v0.6.0-alpha.2
environment:
- DSN=mysql://root:secret@tcp(mysqld:3306)/mysql?max_conns=20&max_idle_conns=4

Expand Down
4 changes: 2 additions & 2 deletions quickstart-postgres.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ version: '3.7'

services:
kratos-migrate:
image: oryd/kratos:v0.6.0-alpha.1
image: oryd/kratos:v0.6.0-alpha.2
environment:
- DSN=postgres://kratos:secret@postgresd:5432/kratos?sslmode=disable&max_conns=20&max_idle_conns=4

kratos:
image: oryd/kratos:v0.6.0-alpha.1
image: oryd/kratos:v0.6.0-alpha.2
environment:
- DSN=postgres://kratos:secret@postgresd:5432/kratos?sslmode=disable&max_conns=20&max_idle_conns=4

Expand Down
4 changes: 2 additions & 2 deletions quickstart.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: '3.7'

services:
kratos-migrate:
image: oryd/kratos:v0.6.0-alpha.1-sqlite
image: oryd/kratos:v0.6.0-alpha.2-sqlite
environment:
- DSN=sqlite:///var/lib/sqlite/db.sqlite?_fk=true&mode=rwc
volumes:
Expand Down Expand Up @@ -30,7 +30,7 @@ services:
kratos:
depends_on:
- kratos-migrate
image: oryd/kratos:v0.6.0-alpha.1-sqlite
image: oryd/kratos:v0.6.0-alpha.2-sqlite
ports:
- '4433:4433' # public
- '4434:4434' # admin
Expand Down

0 comments on commit ba29af4

Please sign in to comment.