zitadel/docs/sidebars.js
Max Peintner a4bbc756d8
docs: console guide (#4468)
* console guide

* org

* orgs, projects

* applications

* project, roles, authz

* users, roles

* app config, imgs

* policy imgs

* users, metadata, imgs

* actions, projects, structure

* css

* rm overview component

* rm manager from sidebar

* fix some broken links, update 🦖

* fix broken links

* fix img shadow

* Update docs/docs/concepts/structure/applications.md

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

* policy link

* link to projects guide

* Update docs/docs/guides/integrate/application/review-config.mdx

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

* add external org authz guide

* Update docs/docs/guides/manage/console/users.mdx

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

* link to example

* readd manager structure

* punto

* docs: domain settings email as username

* docs: links

* project, application settings, screenshots

* Update docs/docs/guides/manage/console/instance-settings.mdx

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

* Update docs/docs/guides/manage/console/instance-settings.mdx

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

* Update docs/docs/guides/manage/console/instance-settings.mdx

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

* Update docs/docs/guides/manage/console/instance-settings.mdx

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

* Update docs/docs/guides/manage/console/instance-settings.mdx

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

* Update docs/docs/guides/manage/console/instance-settings.mdx

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

* Update docs/docs/guides/manage/console/instance-settings.mdx

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

* Update docs/docs/guides/manage/console/instance-settings.mdx

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

* Update docs/docs/guides/manage/console/instance-settings.mdx

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

* Update docs/docs/guides/manage/console/organizations.mdx

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

* iam role

* Update docs/docs/guides/manage/console/managers.mdx

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

* Update docs/docs/guides/manage/console/managers.mdx

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

* change username text

* Update docs/docs/guides/manage/console/roles.mdx

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

* link example

* branding changes

* Update docs/docs/guides/manage/console/organizations.mdx

good point 👍

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

* docs: loginnames

Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>
Co-authored-by: Fabienne <fabienne.gerschwiler@gmail.com>
2022-10-06 16:22:46 +02:00

353 lines
9.0 KiB
JavaScript

module.exports = {
examples: [
"examples/introduction",
{
type: "category",
label: "Integrate ZITADEL Login in your App",
items: [
"examples/login/angular",
"examples/login/react",
"examples/login/flutter",
"examples/login/nextjs",
],
collapsed: false,
},
{
type: "category",
label: "Secure your API",
items: ["examples/secure-api/go", "examples/secure-api/dot-net"],
collapsed: false,
},
{
type: "category",
label: "Call the ZITADEL API",
items: [
"examples/call-zitadel-api/go",
"examples/call-zitadel-api/dot-net",
],
collapsed: false,
},
{
type: "category",
label: "Identity Aware Proxy",
items: ["examples/identity-proxy/oauth2-proxy"],
collapsed: false,
},
],
guides: [
"guides/overview",
{
type: "category",
label: "Get started",
collapsed: false,
items: ["guides/start/quickstart"],
},
{
type: "category",
label: "Deploy",
collapsed: false,
items: [
"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: "Manage",
collapsed: false,
items: [
{
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",
"guides/manage/self-hosted/database/database",
],
},
{
type: "category",
label: "Console",
items: [
"guides/manage/console/overview",
"guides/manage/console/instance-settings",
"guides/manage/console/organizations",
"guides/manage/console/projects",
"guides/manage/console/roles",
"guides/manage/console/applications",
"guides/manage/console/users",
"guides/manage/console/managers",
"guides/manage/console/actions",
],
},
{
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: "Terraform",
items: ["guides/manage/terraform/basics"],
},
],
},
{
type: "category",
label: "Integrate",
collapsed: false,
items: [
"guides/integrate/login-users",
"guides/integrate/identity-brokering",
{
type: "category",
label: "Access ZITADEL APIs",
collapsed: false,
items: [
"guides/integrate/serviceusers",
"guides/integrate/access-zitadel-apis",
"guides/integrate/access-zitadel-system-api",
"guides/integrate/export-and-import",
],
},
{
type: "category",
label: "OpenID Connect 1.0 Clients",
collapsed: false,
items: [
"guides/integrate/oauth-recommended-flows",
"guides/integrate/auth0-oidc",
"guides/integrate/azuread-oidc",
"guides/integrate/authenticated-mongodb-charts",
"guides/integrate/gitlab-self-hosted",
],
},
{
type: "category",
label: "SAML 2.0 Clients",
collapsed: false,
items: [
"guides/integrate/auth0-saml",
"guides/integrate/aws-saml",
"guides/integrate/pingidentity-saml",
"guides/integrate/atlassian-saml",
"guides/integrate/gitlab-saml",
],
},
],
},
{
type: "category",
label: "Solution Scenarios",
collapsed: false,
items: [
"guides/solution-scenarios/introduction",
"guides/solution-scenarios/b2c",
"guides/solution-scenarios/b2b",
],
},
{
type: "category",
label: "Trainings",
collapsed: true,
items: [
"guides/trainings/introduction",
"guides/trainings/application",
"guides/trainings/recurring",
"guides/trainings/project",
],
},
],
apis: [
"apis/introduction",
{
type: "category",
label: "API Definition",
collapsed: false,
items: [
"apis/statuscodes",
{
type: "category",
label: "Proto",
collapsed: true,
items: [
"apis/proto/auth",
"apis/proto/management",
"apis/proto/admin",
"apis/proto/system",
"apis/proto/instance",
"apis/proto/org",
"apis/proto/user",
"apis/proto/app",
"apis/proto/policy",
"apis/proto/auth_n_key",
"apis/proto/change",
"apis/proto/idp",
"apis/proto/member",
"apis/proto/metadata",
"apis/proto/message",
"apis/proto/text",
"apis/proto/action",
"apis/proto/object",
"apis/proto/options",
],
},
{
type: "category",
label: "Assets API",
collapsed: true,
items: ["apis/assets/assets"],
},
"apis/actions",
],
},
{
type: "category",
label: "OpenID Connect & OAuth",
collapsed: false,
items: [
"apis/openidoauth/endpoints",
"apis/openidoauth/scopes",
"apis/openidoauth/claims",
"apis/openidoauth/authn-methods",
"apis/openidoauth/grant-types",
],
},
{
type: "category",
label: "SAML",
collapsed: false,
items: ["apis/saml/endpoints"],
},
{
type: "category",
label: "Observability",
collapsed: false,
items: ["apis/observability/metrics", "apis/observability/health"],
},
{
type: "category",
label: "Rate Limits",
collapsed: false,
items: ["apis/ratelimits/ratelimits", "legal/rate-limit-policy"],
},
],
concepts: [
"concepts/introduction",
"concepts/principles",
{
type: "category",
label: "Eventstore",
collapsed: false,
items: [
"concepts/eventstore/overview",
"concepts/eventstore/implementation",
],
},
{
type: "category",
label: "Architecture",
collapsed: false,
items: [
"concepts/architecture/software",
"concepts/architecture/solution",
"concepts/architecture/secrets",
],
},
{
type: "category",
label: "Structure",
collapsed: false,
items: [
"concepts/structure/overview",
"concepts/structure/instance",
"concepts/structure/organizations",
"concepts/structure/projects",
"concepts/structure/applications",
"concepts/structure/granted_projects",
"concepts/structure/users",
"concepts/structure/managers",
"concepts/structure/policies",
"concepts/structure/jwt_idp",
],
},
{
type: "category",
label: "Use Cases",
collapsed: false,
items: ["concepts/usecases/saas"],
},
{
type: "category",
label: "Features",
collapsed: false,
items: ["concepts/features/actions", "concepts/features/selfservice"],
},
],
manuals: [
"manuals/introduction",
"manuals/user-profile",
"manuals/user-login",
"manuals/troubleshooting",
],
legal: [
"legal/introduction",
"legal/terms-of-service",
"legal/data-processing-agreement",
{
type: "category",
label: "Service Description",
collapsed: false,
items: [
"legal/cloud-service-description",
"legal/service-level-description",
"legal/support-services",
],
},
{
type: "category",
label: "Additional terms",
collapsed: true,
items: [
"legal/terms-support-service",
"legal/terms-of-service-dedicated",
],
},
{
type: "category",
label: "Policies",
collapsed: false,
items: [
"legal/privacy-policy",
"legal/acceptable-use-policy",
"legal/rate-limit-policy",
],
},
],
};