Skip to content

Commit

Permalink
autogen(docs): generate and bump docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr committed Dec 14, 2021
1 parent 54c8c14 commit 718107b
Show file tree
Hide file tree
Showing 189 changed files with 26,940 additions and 54 deletions.
33 changes: 3 additions & 30 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,34 +16,7 @@ project_name: kratos

after:
hooks:
- cmd: npm i
dir: docs
- cmd: |
node "./docs/scripts/docker-tag.js" "docs/config.js" "{{.Tag}}"
- cmd: |
node "./docs/scripts/rerelease.js" "v{{ .Major }}.{{ .Minor }}"
- cmd: |
rm -rf "./docs/versioned_docs/version-v{{ .Major }}.{{ .Minor }}"
- cmd: |
rm -rf "./docs/versioned_sidebars/version-v{{ .Major }}.{{ .Minor }}-sidebars.json"
- cmd: |
npm run docusaurus docs:version "v{{ .Major }}.{{ .Minor }}"
dir: docs
- cmd: |
npm run format
dir: docs
- cmd: |
if [[ $(git describe --tags) == *"pre"* ]]; then
echo "This is a pre-release, skipping docs publishing."
exit 0
fi
bash <(curl -s https://raw.githubusercontent.com/ory/ci/master/src/scripts/install/git.sh)
git add -A
git stash || true
git checkout master || true
git pull -ff || true
git stash pop || true
git commit --allow-empty -a -m "autogen(docs): generate and bump docs" || true
git push origin HEAD:master || true
export DOCS_VERSION="{{ .Major }}.{{ .Minor }}"
export TAG_VERSION="{{ .Tag }}"
bash <(curl -s https://raw.githubusercontent.com/ory/xgoreleaser/master/docs.sh)
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,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.8.0-alpha.4.pre.2
git checkout

```

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.8.0-alpha.4.pre.2
$ docker pull oryd/kratos:
$ docker run --rm -it oryd/kratos help
```

Expand All @@ -33,7 +33,7 @@ On linux, you can use `bash <(curl ...)` to fetch the latest stable binary
using:

```shell
$ bash <(curl https://raw.githubusercontent.com/ory/meta/master/install.sh) -d -b . kratos v0.8.0-alpha.4.pre.2
$ bash <(curl https://raw.githubusercontent.com/ory/meta/master/install.sh) -d -b . kratos
$ ./kratos help
```

Expand Down
19 changes: 8 additions & 11 deletions docs/docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,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.8.0-alpha.4.pre.2
git checkout

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

:::
Expand Down
Empty file.
Loading

0 comments on commit 718107b

Please sign in to comment.