From f3d9c451747898ed9a5abceab6c47089ec293fe1 Mon Sep 17 00:00:00 2001 From: Elio Bischof Date: Thu, 30 Jun 2022 16:06:01 +0200 Subject: [PATCH] docs(installation): fix overview items (#3880) * docs(installation): fix overview items * installation after getting started * fix broken links * fix broken links * fix broken link --- .../installation/configure/configure.mdx | 2 +- .../guides/installation/configure/helm.mdx | 2 +- .../{get-started => run}/compose.mdx | 0 .../{get-started => run}/docker-compose.yaml | 0 .../{get-started => run}/helm.mdx | 0 .../{get-started => run}/knative.mdx | 0 .../{get-started => run}/linux.mdx | 0 .../{get-started => run}/macos.mdx | 0 .../{get-started => run}/nextselfhosted.mdx | 4 +-- .../get-started.mdx => run/run.mdx} | 2 +- .../{get-started => run}/windows.mdx | 0 docs/docs/guides/overview.mdx | 30 +++++++++++++------ docs/docs/legal/data-processing-agreement.mdx | 2 +- docs/docs/legal/terms-support-service.md | 2 +- docs/docusaurus.config.js | 2 +- docs/sidebars.js | 24 +++++++-------- docs/src/pages/index.js | 4 +-- 17 files changed, 43 insertions(+), 31 deletions(-) rename docs/docs/guides/installation/{get-started => run}/compose.mdx (100%) rename docs/docs/guides/installation/{get-started => run}/docker-compose.yaml (100%) rename docs/docs/guides/installation/{get-started => run}/helm.mdx (100%) rename docs/docs/guides/installation/{get-started => run}/knative.mdx (100%) rename docs/docs/guides/installation/{get-started => run}/linux.mdx (100%) rename docs/docs/guides/installation/{get-started => run}/macos.mdx (100%) rename docs/docs/guides/installation/{get-started => run}/nextselfhosted.mdx (77%) rename docs/docs/guides/installation/{get-started/get-started.mdx => run/run.mdx} (98%) rename docs/docs/guides/installation/{get-started => run}/windows.mdx (100%) diff --git a/docs/docs/guides/installation/configure/configure.mdx b/docs/docs/guides/installation/configure/configure.mdx index 9778ce397d..08ebf4130c 100644 --- a/docs/docs/guides/installation/configure/configure.mdx +++ b/docs/docs/guides/installation/configure/configure.mdx @@ -11,7 +11,7 @@ import Helm from './helm.mdx' # Configure ZITADEL -This guide assumes you are already familiar with [running ZITADEL with the most minimal configuration possible](./get-started). +This guide assumes you are already familiar with [running ZITADEL with the most minimal configuration possible](./run). ## Configuration Files diff --git a/docs/docs/guides/installation/configure/helm.mdx b/docs/docs/guides/installation/configure/helm.mdx index fbc5560b89..700a6945a0 100644 --- a/docs/docs/guides/installation/configure/helm.mdx +++ b/docs/docs/guides/installation/configure/helm.mdx @@ -1,7 +1,7 @@ By default, the chart installs a secure ZITADEL and CockroachDB. The example files makes an insecure ZITADEL accessible by port forwarding the ZITADEL service to localhost. For more configuration options, [go to the chart repo descriptions](https://github.com/zitadel/zitadel-charts). -For a secure installation with Docker Compose, [go to the loadbalancing example](../loadbalancing-example/loadbalancing-example) +For a secure installation with Docker Compose, [go to the loadbalancing example](/docs/guides/installation/loadbalancing-example) By executing the commands below, you will download the following files: - [example-zitadel-values.yaml](./example-zitadel-values.yaml) diff --git a/docs/docs/guides/installation/get-started/compose.mdx b/docs/docs/guides/installation/run/compose.mdx similarity index 100% rename from docs/docs/guides/installation/get-started/compose.mdx rename to docs/docs/guides/installation/run/compose.mdx diff --git a/docs/docs/guides/installation/get-started/docker-compose.yaml b/docs/docs/guides/installation/run/docker-compose.yaml similarity index 100% rename from docs/docs/guides/installation/get-started/docker-compose.yaml rename to docs/docs/guides/installation/run/docker-compose.yaml diff --git a/docs/docs/guides/installation/get-started/helm.mdx b/docs/docs/guides/installation/run/helm.mdx similarity index 100% rename from docs/docs/guides/installation/get-started/helm.mdx rename to docs/docs/guides/installation/run/helm.mdx diff --git a/docs/docs/guides/installation/get-started/knative.mdx b/docs/docs/guides/installation/run/knative.mdx similarity index 100% rename from docs/docs/guides/installation/get-started/knative.mdx rename to docs/docs/guides/installation/run/knative.mdx diff --git a/docs/docs/guides/installation/get-started/linux.mdx b/docs/docs/guides/installation/run/linux.mdx similarity index 100% rename from docs/docs/guides/installation/get-started/linux.mdx rename to docs/docs/guides/installation/run/linux.mdx diff --git a/docs/docs/guides/installation/get-started/macos.mdx b/docs/docs/guides/installation/run/macos.mdx similarity index 100% rename from docs/docs/guides/installation/get-started/macos.mdx rename to docs/docs/guides/installation/run/macos.mdx diff --git a/docs/docs/guides/installation/get-started/nextselfhosted.mdx b/docs/docs/guides/installation/run/nextselfhosted.mdx similarity index 77% rename from docs/docs/guides/installation/get-started/nextselfhosted.mdx rename to docs/docs/guides/installation/run/nextselfhosted.mdx index 65ca1c497a..d79a8b2ae4 100644 --- a/docs/docs/guides/installation/get-started/nextselfhosted.mdx +++ b/docs/docs/guides/installation/run/nextselfhosted.mdx @@ -5,9 +5,9 @@ This is the default IAM admin users login: ## What's next -For running a production grade ZITADEL instance in your environment, go on with the [configure ZITADEL](./configure) section. +For running a production grade ZITADEL instance in your environment, go on with the [configure ZITADEL](/docs/guides/installation/configure) section. :::caution -The ZITADEL management console [requires end-to-end HTTP/2 support](./http2-support) +The ZITADEL management console [requires end-to-end HTTP/2 support](/docs/guides/installation/http2-support) diff --git a/docs/docs/guides/installation/get-started/get-started.mdx b/docs/docs/guides/installation/run/run.mdx similarity index 98% rename from docs/docs/guides/installation/get-started/get-started.mdx rename to docs/docs/guides/installation/run/run.mdx index d37b2f39a5..8c6cb16c89 100644 --- a/docs/docs/guides/installation/get-started/get-started.mdx +++ b/docs/docs/guides/installation/run/run.mdx @@ -1,5 +1,5 @@ --- -title: Get Started +title: Run --- import Tabs from "@theme/Tabs"; diff --git a/docs/docs/guides/installation/get-started/windows.mdx b/docs/docs/guides/installation/run/windows.mdx similarity index 100% rename from docs/docs/guides/installation/get-started/windows.mdx rename to docs/docs/guides/installation/run/windows.mdx diff --git a/docs/docs/guides/overview.mdx b/docs/docs/guides/overview.mdx index 3e3f0c090f..015fd36373 100644 --- a/docs/docs/guides/overview.mdx +++ b/docs/docs/guides/overview.mdx @@ -7,7 +7,7 @@ import Column from "../../src/components/column"; With our guides you will learn everything you need to know about specific topics. You get step-by-step instructions for certain tasks and have a knowledge check at the end. -You can either use our cloud-instance [zitadel.com](https://zitadel.com) or deploy your own **ZITADEL** instance. To get started, we recommend you to try out our free tier first. Jump directly to the [get started](./installation) docs. +You can either use our cloud-instance [zitadel.com](https://zitadel.com) or deploy your own **ZITADEL** instance. To get started, we recommend you to try out our free tier first. Jump directly to the [get started](./basics/get-started) docs. @@ -30,6 +30,26 @@ You can either use our cloud-instance [zitadel.com](https://zitadel.com) or depl description="Understand projects and grants" /> + + + + + - - - diff --git a/docs/docs/legal/data-processing-agreement.mdx b/docs/docs/legal/data-processing-agreement.mdx index dff5e239ff..ebea490292 100644 --- a/docs/docs/legal/data-processing-agreement.mdx +++ b/docs/docs/legal/data-processing-agreement.mdx @@ -33,7 +33,7 @@ The Processor is responsible for taking appropriate technical and organizational ### Bound by directions -The Processor processes personal data in accordance with its privacy policy (cf. [Privacy Policy](privacy-policy.md)) and on the documented directions of the Customer. The initial direction result from the Agreement. Subsequent instructions shall be given either in writing, whereby e-mail shall suffice, or orally with immediate written confirmation. +The Processor processes personal data in accordance with its privacy policy (cf. [Privacy Policy](/docs/legal/privacy-policy)) and on the documented directions of the Customer. The initial direction result from the Agreement. Subsequent instructions shall be given either in writing, whereby e-mail shall suffice, or orally with immediate written confirmation. If the Processor is of the opinion that a direction of the Customer violates the Agreement, the GDPR or other data protection provisions of the EU, EU Member States or Switzerland, it shall inform the Customer thereof and shall be entitled to suspend the Processing until the instruction is withdrawn or confirmed. diff --git a/docs/docs/legal/terms-support-service.md b/docs/docs/legal/terms-support-service.md index d6294ac0a7..bb8a2fc333 100644 --- a/docs/docs/legal/terms-support-service.md +++ b/docs/docs/legal/terms-support-service.md @@ -146,7 +146,7 @@ Recertification of a unit, to be covered under Support Services, is required for * units that run a release that is older than 180 days from the products most recent stable release * requests for support on products and services purchased or supported from non-authorized resellers -Recertification of a unit requires payment of a Recertification Fee which results in a [checkup](/docs/guides/installation/checkup) of the unit by CAOS. The unit will be inspected to asses its condition and eligibility for service coverage. +Recertification of a unit requires payment of a Recertification Fee which results in a checkup of the unit by CAOS. The unit will be inspected to asses its condition and eligibility for service coverage. Please contact us for current fees. diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 1bf7237d95..cd85593451 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -4,7 +4,7 @@ module.exports = { trailingSlash: false, url: "https://docs.zitadel.com", baseUrl: "/", - onBrokenLinks: "warn", + onBrokenLinks: "throw", onBrokenMarkdownLinks: "warn", favicon: "img/favicon.ico", organizationName: "zitadel", diff --git a/docs/sidebars.js b/docs/sidebars.js index 1ed92edd40..59df0fac83 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -36,18 +36,6 @@ module.exports = { ], guides: [ "guides/overview", - { - type: "category", - label: "Install ZITADEL", - collapsed: false, - items: [ - "guides/installation/get-started/get-started", - "guides/installation/configure/configure", - "guides/installation/custom-domain", - "guides/installation/http2-support", - "guides/installation/loadbalancing-example/loadbalancing-example", - ], - }, { type: "category", label: "Get to know ZITADEL", @@ -60,6 +48,18 @@ module.exports = { "guides/basics/applications", ], }, + { + type: "category", + label: "Install ZITADEL", + collapsed: false, + items: [ + "guides/installation/run/run", + "guides/installation/configure/configure", + "guides/installation/custom-domain", + "guides/installation/http2-support", + "guides/installation/loadbalancing-example/loadbalancing-example", + ], + }, { type: "category", label: "Integrations", diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js index bab5d0665b..0981c42c99 100644 --- a/docs/src/pages/index.js +++ b/docs/src/pages/index.js @@ -67,8 +67,8 @@ const features = [ description="" />