From 9326061f1ad175a46bd9f36df2a58e56765176af Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Tue, 2 Aug 2022 13:30:11 +0200 Subject: [PATCH] docs: fix broken links and typos (#4085) * docs: fix broken links * some language fixes Co-authored-by: Elio Bischof --- docs/docs/guides/deploy/compose.mdx | 6 +++--- .../loadbalancing-example.mdx | 20 +++++++++---------- docs/docs/guides/deploy/overview.mdx | 4 ++-- .../manage/self-hosted/configure/_compose.mdx | 8 ++++---- 4 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/docs/guides/deploy/compose.mdx b/docs/docs/guides/deploy/compose.mdx index 57f0347c53..8c2fc7c1b4 100644 --- a/docs/docs/guides/deploy/compose.mdx +++ b/docs/docs/guides/deploy/compose.mdx @@ -17,13 +17,13 @@ By executing the commands below, you will download the following file: ```bash -# Download the docker compose example configuration. For example: +# Download the docker compose example configuration. wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/guides/deploy/docker-compose.yaml -# Run the database and application containers +# Run the database and application containers. docker compose up --detach ``` - \ No newline at end of file + diff --git a/docs/docs/guides/deploy/loadbalancing-example/loadbalancing-example.mdx b/docs/docs/guides/deploy/loadbalancing-example/loadbalancing-example.mdx index 329fd44f1e..488454917f 100644 --- a/docs/docs/guides/deploy/loadbalancing-example/loadbalancing-example.mdx +++ b/docs/docs/guides/deploy/loadbalancing-example/loadbalancing-example.mdx @@ -37,20 +37,20 @@ By executing the commands below, you will download the following files: ```bash -# Download the docker compose example configuration. For example: -wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/guides/deploye/loadbalancing-example/loadbalancing-example/docker-compose.yaml +# Download the docker compose example configuration. +wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/guides/deploy/loadbalancing-example/docker-compose.yaml -# Download the docker compose example configuration. For example: -wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/guides/deploye/loadbalancing-example/loadbalancing-example/example-traefik.yaml +# Download the Traefik example configuration. +wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/guides/deploy/loadbalancing-example/example-traefik.yaml -# Download and adjust the example configuration file containing standard configuration -wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/guides/deploye/loadbalancing-example/loadbalancing-example/example-zitadel-config.yaml +# Download and adjust the example configuration file containing standard configuration. +wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/guides/deploy/loadbalancing-example/example-zitadel-config.yaml -# Download and adjust the example configuration file containing secret configuration -wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/guides/deploye/loadbalancing-example/loadbalancing-example/example-zitadel-secrets.yaml +# Download and adjust the example configuration file containing secret configuration. +wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/guides/deploy/loadbalancing-example/example-zitadel-secrets.yaml -# Download and adjust the example configuration file containing database initialization configuration -wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/guides/deploye/loadbalancing-example/loadbalancing-example/example-zitadel-init-steps.yaml +# Download and adjust the example configuration file containing database initialization configuration. +wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/guides/deploy/loadbalancing-example/example-zitadel-init-steps.yaml # A single ZITADEL instance always needs the same 32 characters long masterkey # If you haven't done so already, you can generate a new one. diff --git a/docs/docs/guides/deploy/overview.mdx b/docs/docs/guides/deploy/overview.mdx index f2e3cc5d92..bcbbeab027 100644 --- a/docs/docs/guides/deploy/overview.mdx +++ b/docs/docs/guides/deploy/overview.mdx @@ -14,6 +14,6 @@ By default, it runs a highly available ZITADEL instance along with a secure and ## Prerequisits -- ZITADEL does not need much resource 1 CPU and 512MB memory is more than enough. (With more CPU the password hashing might be faster) +- ZITADEL does not need many resources, 1 CPU and 512MB memory are more than enough. (With more CPU, the password hashing might be faster) - A cockroachDB or [🚧 Postgresql coming soon](https://github.com/zitadel/zitadel/pull/3998) as only needed storage -- If you want to front ZTIADEL with a revers proxy, web application firewall or content delivery network make sure to support [HTTP/2](../manage/self-hosted/http2) \ No newline at end of file +- If you want to front ZITADEL with a reverse proxy, web application firewall or content delivery network, make sure to support [HTTP/2](../manage/self-hosted/http2) diff --git a/docs/docs/guides/manage/self-hosted/configure/_compose.mdx b/docs/docs/guides/manage/self-hosted/configure/_compose.mdx index d6a6006513..836dc0d033 100644 --- a/docs/docs/guides/manage/self-hosted/configure/_compose.mdx +++ b/docs/docs/guides/manage/self-hosted/configure/_compose.mdx @@ -22,16 +22,16 @@ By executing the commands below, you will download the following files: ```bash -# Download the docker compose example configuration for a secure CockroachDB. For example: +# Download the docker compose example configuration for a secure CockroachDB. wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/guides/manage/self-hosted/configure/docker-compose.yaml -# Download and adjust the example configuration file containing standard configuration +# Download and adjust the example configuration file containing standard configuration. wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/guides/manage/self-hosted/configure/example-zitadel-config.yaml -# Download and adjust the example configuration file containing secret configuration +# Download and adjust the example configuration file containing secret configuration. wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/guides/manage/self-hosted/configure/example-zitadel-secrets.yaml -# Download and adjust the example configuration file containing database initialization configuration +# Download and adjust the example configuration file containing database initialization configuration. wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/docs/guides/manage/self-hosted/configure/example-zitadel-init-steps.yaml # A single ZITADEL instance always needs the same 32 characters long masterkey