docs: improve documentation for v2 release (#4046)

* WIP: docs(proxy): describe proxy settings

* fix nginx

* refactor (docs): deploy and operate sections

* chore: ignore package-lock since we use yarn

* chore: update to rc1

* chore: broken links

* chore: update yarn

* docs: move disclaimer to bottom

* chore: fix broken links

* Update docs/docs/guides/operate/tls_modes.mdx

Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>

* test caddy files

* syntax highlight

* traefik example

* refactor: docs

* refactor

* working state

* got a working state

* remove bar

* mark rate limits for update

* remove zitadel.ch

* fix cases

* docs: zitadel quickstart

* docs: zitadel quickstart

* docs: create app and project

* docs: move customer portal docs to guides manage cloud

* docs: move customer portal docs to guides manage cloud

* docs: move customer portal docs to guides manage cloud

* docs: add help me choose in the quickstart

* docs: broken links

* fix broken links

* Update knative guide

* styling

* docs: support customer portal

* update to main instead v2-alpha

* use version 2 tag

* docs: images

* docs: move authentication and authorization guides to integrate

* docs: quickstart use examples

* docs: lb example

* fix broken link

* docs: update userinfo endpoints

* docs: update userinfo endpoints

* fix oidc endpoint

* docs: remove unused endpoints in app.module

Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>
Co-authored-by: Fabienne <fabienne.gerschwiler@gmail.com>
Co-authored-by: Livio Amstutz <livio.a@gmail.com>
This commit is contained in:
Florian Forster
2022-07-29 10:13:45 +02:00
committed by GitHub
parent fb52575f79
commit 3c3bce1a6b
123 changed files with 3212 additions and 25673 deletions

View File

@@ -1,36 +1,38 @@
module.exports = {
quickstarts: [
"quickstarts/introduction",
examples: [
"examples/introduction",
{
type: "category",
label: "Integrate ZITADEL Login in your App",
items: [
"quickstarts/login/angular",
"quickstarts/login/react",
"quickstarts/login/flutter",
"quickstarts/login/nextjs",
"examples/login/angular",
"examples/login/react",
"examples/login/flutter",
"examples/login/nextjs",
],
collapsed: false,
},
{
type: "category",
label: "Secure your API",
items: ["quickstarts/secure-api/go", "quickstarts/secure-api/dot-net"],
items: [
"examples/secure-api/go",
"examples/secure-api/dot-net"],
collapsed: false,
},
{
type: "category",
label: "Call the ZITADEL API",
items: [
"quickstarts/call-zitadel-api/go",
"quickstarts/call-zitadel-api/dot-net",
"examples/call-zitadel-api/go",
"examples/call-zitadel-api/dot-net",
],
collapsed: false,
},
{
type: "category",
label: "Identity Aware Proxy",
items: ["quickstarts/identity-proxy/oauth2-proxy"],
items: ["examples/identity-proxy/oauth2-proxy"],
collapsed: false,
},
],
@@ -38,36 +40,90 @@ module.exports = {
"guides/overview",
{
type: "category",
label: "Get to know ZITADEL",
label: "Get started",
collapsed: false,
items: [
"guides/basics/get-started",
"guides/basics/instance",
"guides/basics/organizations",
"guides/basics/projects",
"guides/basics/applications",
"guides/start/quickstart",
],
},
{
type: "category",
label: "Install ZITADEL",
label: "Deploy",
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",
"guides/deploy/overview",
"guides/deploy/linux",
"guides/deploy/macos",
"guides/deploy/compose",
"guides/deploy/knative",
"guides/deploy/kubernetes",
"guides/deploy/loadbalancing-example/loadbalancing-example",
],
},
{
type: "category",
label: "Integrations",
label: "Manage",
collapsed: false,
items: [
"guides/integrations/authenticated-mongodb-charts",
"guides/integrations/auth0",
"guides/integrations/gitlab-self-hosted",
{
type: 'category',
label: 'Cloud',
items: [
"guides/manage/cloud/overview",
"guides/manage/cloud/start",
"guides/manage/cloud/instances",
"guides/manage/cloud/billing",
"guides/manage/cloud/users",
"guides/manage/cloud/support",
]
},
{
type: 'category',
label: 'Self-Hosted',
items: [
"guides/manage/self-hosted/configure/configure",
"guides/manage/self-hosted/proxy/proxy",
"guides/manage/self-hosted/custom-domain",
"guides/manage/self-hosted/http2",
"guides/manage/self-hosted/tls_modes",
]
},
{
type: 'category',
label: 'Console',
items: [
"guides/manage/console/organizations",
"guides/manage/console/projects",
"guides/manage/console/applications",
]
},
{
type: 'category',
label: 'Customize',
items: [
"guides/manage/customize/branding",
"guides/manage/customize/texts",
"guides/manage/customize/behavior",
"guides/manage/customize/user-metadata",
]
}
],
},
{
type: "category",
label: "Integrate",
collapsed: false,
items: [
"guides/integrate/identity-brokering",
"guides/integrate/access-zitadel-apis",
"guides/integrate/authenticated-mongodb-charts",
"guides/integrate/auth0",
"guides/integrate/gitlab-self-hosted",
"guides/integrate/login-users",
"guides/integrate/serviceusers",
"guides/integrate/oauth-recommended-flows",
"guides/integrate/export-and-import"
],
},
{
@@ -80,42 +136,6 @@ module.exports = {
"guides/solution-scenarios/b2b",
],
},
{
type: "category",
label: "Authentication",
collapsed: false,
items: [
"guides/authentication/login-users",
"guides/authentication/identity-brokering",
"guides/authentication/serviceusers",
],
},
{
type: "category",
label: "Authorization",
collapsed: false,
items: ["guides/authorization/oauth-recommended-flows"],
},
{
type: "category",
label: "API",
collapsed: false,
items: [
"guides/api/access-zitadel-apis",
"guides/api/export-and-import"
],
},
{
type: "category",
label: "Customization",
collapsed: false,
items: [
"guides/customization/branding",
"guides/customization/texts",
"guides/customization/behavior",
"guides/customization/user-metadata"
],
},
{
type: "category",
label: "Trainings",
@@ -188,7 +208,7 @@ module.exports = {
collapsed: false,
items: [
"legal/rate-limit-policy",
"apis/ratelimits/accounts",
"apis/ratelimits/login",
"apis/ratelimits/api",
],
},
@@ -239,19 +259,6 @@ module.exports = {
"manuals/introduction",
"manuals/user-profile",
"manuals/user-login",
{
type: "category",
label: "Customer Portal",
collapsed: true,
items: [
"manuals/customerportal/overview",
"manuals/customerportal/start",
"manuals/customerportal/instances",
"manuals/customerportal/billing",
"manuals/customerportal/users",
"manuals/customerportal/support",
],
},
"manuals/troubleshooting",
],
legal: [