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 4, 2020
1 parent 7c6c439 commit a73a6d8
Show file tree
Hide file tree
Showing 53 changed files with 18,211 additions and 153 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ git clone https://github.com/ory/kratos.git
# or if you have git+ssh set up:
# git clone git@github.com:ory/kratos.git
cd kratos
git checkout v0.1.1-alpha.1
git checkout v0.2.0-alpha.2

docker pull oryd/kratos:latest-sqlite
docker pull oryd/kratos-selfservice-ui-node:latest
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.1.1-alpha.1
$ docker pull oryd/kratos:v0.2.0-alpha.2
$ docker run --rm -it oryd/kratos help
```

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

Expand Down
25 changes: 12 additions & 13 deletions docs/docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@ const needsLogin = (req, res, next) => {

:::info

ORY Kratos is not just an API, it uses cookies, HTTP redirects,
Anti-CSRF Tokens and more so you don't have to!
ORY Kratos is not just an API, it uses cookies, HTTP redirects, Anti-CSRF Tokens
and more so you don't have to!

:::

Expand Down Expand Up @@ -134,20 +134,19 @@ that Docker has enough disk space.

:::tip

This tutorial uses Docker-Compose volumes which have reported to run out
of disk space. Check the remaining disk space using `docker system df`. If the
volumes are above the 85% threshold,
This tutorial uses Docker-Compose volumes which have reported to run out of disk
space. Check the remaining disk space using `docker system df`. If the volumes
are above the 85% threshold,
[prune old Docker objects](https://docs.docker.com/config/pruning/) before you
start!

:::

:::tip

If you encounter build errors (e.g. network timeout), make sure that the
network is running correctly and run `macke docker` again. If the problem
persists, feel free to
[open an issue](https://github.com/ory/kratos/issues/new/choose).
If you encounter build errors (e.g. network timeout), make sure that the network
is running correctly and run `macke docker` again. If the problem persists, feel
free to [open an issue](https://github.com/ory/kratos/issues/new/choose).

:::

Expand Down Expand Up @@ -185,7 +184,7 @@ There are two important factors to get a fully functional system:
- Make sure to always use `127.0.0.1` as the hostname, never use `localhost`!
This is important because browsers treat these two as separate domains and
will therefore have issues with setting and using the right cookies.

:::

You might notice that no database is being used in this example. ORY Kratos
Expand Down Expand Up @@ -405,9 +404,9 @@ this documentation.

:::note

To get a minimal version of ORY Kratos running, you need to set configuration items
`identity.traits.default_schema_url` and `dsn`. You should also configure `urls.*_ui`
because your users will end up at fallbacks otherwise.
To get a minimal version of ORY Kratos running, you need to set configuration
items `identity.traits.default_schema_url` and `dsn`. You should also configure
`urls.*_ui` because your users will end up at fallbacks otherwise.

:::

Expand Down

0 comments on commit a73a6d8

Please sign in to comment.