Commit Graph

24 Commits

Author SHA1 Message Date
Max Peintner
1b923425cd
chore(docs): downgrade react (#6374)
* chore(docs): downgrade react

* remove --no-minify
2023-08-16 08:44:16 +00:00
Max Peintner
88751681d8
docs: cleanup deps (#6313)
* docs(search): add getMissingResultsUrl

* deps

* deps

* downgrade docusaurus again to 2.2.0

* fix angualar, nextjs guides

* Update docs/docusaurus.config.js

Co-authored-by: Florian Forster <florian@zitadel.com>

---------

Co-authored-by: mffap <mpa@zitadel.com>
Co-authored-by: Florian Forster <florian@zitadel.com>
2023-08-12 08:58:44 +00:00
Elio Bischof
7bc4aa9c76
docs: copy config options to docs (#6143)
* poc

* wip

* works

* upgrade yaml package

* need to add global comments for shifting

* wip: need index before working on comments

* green

* clean up

* test null value

* comment

* package

* delete

* convert to module

* render md table

* tests with ESM

* comments

* top level gitignore

* wip: new cases

* arrays: green

* array_test

* treat comments on map without first element

* fix some new case

* skip leaf comments

* output folder

* comment

* finish up for poc

* arrays

* create output dir

* merge main, create tables

* copy config options to docs

* cleanup

* recommend file configuration

* language

* add some explanations

* some small typo fixes

---------

Co-authored-by: mffap <mpa@zitadel.com>
Co-authored-by: Florian Forster <florian@zitadel.com>
2023-08-07 22:32:10 +02:00
mffap
9257cf7086
docs(playground): save to clipboard (#5488)
* docs(playground): permanent link

* add scope urn:zitadel:iam:org:project:roles

* remove window

* remove copy

* move to top right of card, fresh lockfile

* remove scope

* copy to clipboard

* browser only

* cleanup

* try with plausible css

* remove plausible plugin

* remove plausible window

* fix plausible in preview

* plausible script

---------

Co-authored-by: Max Peintner <max@caos.ch>
Co-authored-by: Florian Forster <florian@zitadel.com>
2023-03-22 07:19:19 +00:00
mffap
8d4d182c20
docs: proposal restructure (#5318)
* docs: docs structure

* docs: remove sdk from main nav

* docs: fix broken links

* docs: texts

* docs: texts

* docs: react example

* docs: proposal restructure

* remove manual, move troubleshooting

* revmove duplicate item

* identity providers

* broken links and rel paths

* examples wip

* examples

* navigation

* support

* solution scenarios

* concepts

* overview

* Actions caution to info

* suggestions from code review

* remove start command again

* proposed start command (with and without api)

* wip startpage

* startpage

* broken link integrate

* remove get started from nav

* Apply suggestions from code review

Co-authored-by: Elio Bischof <elio@zitadel.com>

---------

Co-authored-by: Fabienne <fabienne.gerschwiler@gmail.com>
Co-authored-by: Florian Forster <florian@zitadel.com>
Co-authored-by: Elio Bischof <elio@zitadel.com>
2023-03-07 09:33:13 +02:00
Florian Forster
aa9518ac02
docs: improve api docs (#5158)
* integrate docs into nav

* generator for local use, production needs to be set by env

* fix typo

* local dev

* docs: annotate the first user endpoints in the management api

* docs: annotate the first user endpoints in the management api

* docs: annotate the first user endpoints in the management api

* docs: annotate the first user endpoints in the management api

* docs: add header params

* rewrite docs links and improve ci

* tweak build command

* fix path

* Update docs/docusaurus.config.js

Co-authored-by: Max Peintner <max@caos.ch>

* fix docker

* docs: add header params

* docs: Add tags to management api. add some descriptions

* docs: more descriptions

* docs: more descriptions

* docs: required fields

* docs: example request

* docs: example request

* docs: example request

* docs: example request

* docs: example request

* docs: user metadata requests

* docs: user requests

* docs: user requests

* docs: user requests

* docs: user requests

* docs: change nav add first methods to authentication api

* docs: auth api

* docs: auth api

* docs: auth api

* docs: auth api

* docs: auth api

* docs: api sidenav

* chore: use buf without docker

* fix deploy

* fix ci

* fix vercel

* docs: admin

* docs: admin api docs

* docs: admin api docs

* docs: admin api docs

* docs: admin api docs

* docs: security

* docs: security

* docs: admin api

* docs: change to env vars

* docs: auth api

* docs: remove assets, deprecated requests, menu

* reworked page with PaloAltoNetworks/docusaurus-openapi-docs

* works with the resolutions

* fix broken build by adding assets again

* add tags to menu

* chore: improve build speed

* no-minify

* test ssr

* ssr 20

* use lazy

* increase mem

* use default mem

* change names

* docs: remove assets, deprecated requests, menu

* docs: management api

* docs: management api

* docs: management api

* docs: sidebar

* not the best word smithing but it is ;-)

* more typos

* merge main

* fix some error

* trial

* update grpc gateway

* trigger vercel build

* docs: deprecated requests

* docs: deprecated requests

---------

Co-authored-by: Fabienne <fabienne.gerschwiler@gmail.com>
Co-authored-by: Max Peintner <max@caos.ch>
2023-02-23 18:08:06 +07:00
dependabot[bot]
3003b0b0dc
chore(deps): bump mermaid from 8.14.0 to 9.1.2 in /docs (#3900)
Bumps [mermaid](https://github.com/knsv/mermaid) from 8.14.0 to 9.1.2.
- [Release notes](https://github.com/knsv/mermaid/releases)
- [Changelog](https://github.com/mermaid-js/mermaid/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/knsv/mermaid/compare/8.14.0...9.1.2)

---
updated-dependencies:
- dependency-name: mermaid
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Livio Spring <livio.a@gmail.com>
2023-02-17 08:06:03 +01:00
Max Peintner
97fe041a86
docs: add tailwindcss for styles, oidc authorize endpoint playground (#4707)
* variable parser

* rm plugin

* set fcn

* env

* EnvCode component

* cleanup env demo

* env

* rm remark plugin

* auth request context

* auth req component

* authorize endpoint construction

* rev react page

* fix endpoint

* styling

* query params with anchor

* desc

* tailwind coexistence

* fix styles

* add login_hint, organizationId scope

* auth request without prompt

* show login_hint

* sync displayed url with actual href

* fix fcn

* coloring

* Update docs/src/components/authrequest.jsx

Co-authored-by: mffap <mpa@zitadel.com>

* Update docs/src/components/authrequest.jsx

Co-authored-by: mffap <mpa@zitadel.com>

* Update docs/src/components/authrequest.jsx

Co-authored-by: mffap <mpa@zitadel.com>

* Update docs/src/components/authrequest.jsx

Co-authored-by: mffap <mpa@zitadel.com>

* Update docs/src/components/authrequest.jsx

Co-authored-by: mffap <mpa@zitadel.com>

* Update docs/src/components/authrequest.jsx

Co-authored-by: mffap <mpa@zitadel.com>

* add plausible, header

* add pkce

* move

* adds pkce code challenge

* replace cboa

* reaname and move to required

* fall back to cboa due to webpack error

* trailing slash

* reorder org_id

* remove resourceowner

* texts

* update references

* buffer, fix some react dom components

* Apply suggestions from code review

Co-authored-by: Florian Forster <florian@zitadel.com>

* standard scopes

Co-authored-by: mffap <mpa@zitadel.com>
Co-authored-by: Florian Forster <florian@zitadel.com>
2022-12-05 18:36:12 +01:00
Max Peintner
92eeb68be9
docs: update nextjs and angular guide (#4633)
* docs: nextjs angular guide

* colormode
2022-10-31 08:00:22 +01:00
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
Florian Forster
c14c66820f
docs: update docusaurus, add metrics endpoint, add zero downtime update (#4376)
* chore: update docusuarus to 2.1.0

* docs: metrics endpoint docs

* docs: zero downtime updates

* Update docs/docs/concepts/architecture/solution.md

Co-authored-by: mffap <mpa@zitadel.com>

* Update docs/docs/concepts/architecture/solution.md

Co-authored-by: mffap <mpa@zitadel.com>

* Update docs/docs/concepts/architecture/solution.md

Co-authored-by: mffap <mpa@zitadel.com>

* docs: add health / ready

* Update docs/docs/apis/observability/health.md

Co-authored-by: mffap <mpa@zitadel.com>

Co-authored-by: mffap <mpa@zitadel.com>
2022-09-15 16:36:02 +02:00
Florian Forster
4e7f0eaec9
docs: create secrets concepts and update docusaurus to stable release (#4111)
* chore: update docusaurus to v2

* extend concepts for secrets handling

* fix links

* add credentials

* docs review with @livio-a

* remove change

Co-authored-by: Livio Spring <livio.a@gmail.com>
2022-08-04 14:08:24 +00:00
Florian Forster
3c3bce1a6b
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>
2022-07-29 10:13:45 +02:00
Elio Bischof
7ef9dcbf50
docs(installation): inline file contents (#3974)
* docs(installation): align knative style

* some fixes in configure section

* show file contents inline
2022-07-15 13:59:58 +02:00
mffap
36d0f9668b
fix(docs): image zoom plugin (#3946)
fix: image zoom plugin

Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>
2022-07-14 09:52:04 +00:00
Fabi
c53d5251a7
fix: V2 docs / error messages (#3611)
* docs: rewrite concept section

* docs: add instance to guides

* chore: error messages

* fix: scenarios

* docs: urls

* docs: change images

* docs: change images

* docs: change images

Co-authored-by: Livio Amstutz <livio.a@gmail.com>
2022-05-16 12:00:33 +00:00
Max Peintner
22c9cf99e7
docs: update deps, fix zitadel logo size (#3122) 2022-01-31 13:36:16 +01:00
Florian Forster
5f2b88be51
docs: fix broken docs pipeline (#2936)
* refactor user login guide (#2921)

* docs: fix docusaurus issues

* update yarn dep

Co-authored-by: Max Peintner <max@caos.ch>
2022-01-06 08:02:40 +01:00
Fabi
f14ca1dc00
docs: Admin training (#2436)
* docs: zitadel concepts

* docs: zitadel concepts

* docs: zitadel concepts

* docs: graphics

* docs: graphics

* docs: image zoom

* docs: readme fix

* docs: applications

* fix: graphics

* add plugins

* fix: links

* Update docs/docs/concepts/zitadel/objects/projects.md

Co-authored-by: Livio Amstutz <livio.a@gmail.com>

* Update docs/docs/concepts/zitadel/objects/projects.md

Co-authored-by: Livio Amstutz <livio.a@gmail.com>

* Update docs/docs/concepts/zitadel/objects/projects.md

Co-authored-by: Livio Amstutz <livio.a@gmail.com>

* Update docs/docs/concepts/zitadel/objects/projects.md

Co-authored-by: Livio Amstutz <livio.a@gmail.com>

* Update docs/docs/concepts/zitadel/objects/projects.md

Co-authored-by: Livio Amstutz <livio.a@gmail.com>

* Update docs/docs/concepts/zitadel/objects/projects.md

Co-authored-by: Livio Amstutz <livio.a@gmail.com>

* Update docs/docs/concepts/zitadel/objects/applications.md

Co-authored-by: Livio Amstutz <livio.a@gmail.com>

Co-authored-by: Livio Amstutz <livio.a@gmail.com>
2021-09-30 11:49:57 +02:00
Fabi
c8d59ee488
docs: restructure and add more content (#2232)
* docs: restructure quickstarts

* docs: quickstart libs

* docs: add exlixir lib

* docs: restructure

* docs: restructure

* docs: customization

* use tabs in oauth/oidc endpoints.md

* improve authorize_endpoint

* improve token_endpoint and introspection_endpoint

* docs: saas use case

* styling

* styling

* begin login users

* login users

* login users

* fix table

* fix: links

* fix: links

* start go api

* fix: policy structure

* fix: saas description

* fix: saas description

* fix: saas description

* Update docs/docs/concepts/policies.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* docs: organisation --> organization

* docs: fixes

* docs: fixes

* Update docs/docs/apis/openidoauth/endpoints.md

Co-authored-by: Florian Forster <florian@caos.ch>

* Update docs/docs/concepts/policies.md

Co-authored-by: Florian Forster <florian@caos.ch>

* Update docs/docs/concepts/policies.md

Co-authored-by: Florian Forster <florian@caos.ch>

* Update docs/docs/concepts/policies.md

Co-authored-by: Florian Forster <florian@caos.ch>

* Update docs/docs/apis/openidoauth/endpoints.md

Co-authored-by: Florian Forster <florian@caos.ch>

* Apply suggestions from code review

Co-authored-by: Florian Forster <florian@caos.ch>

* docs: intro

* Update docs/docs/guides/customization/branding.md

Co-authored-by: Florian Forster <florian@caos.ch>

* fix: typo

* add mermaid

Co-authored-by: Livio Amstutz <livio.a@gmail.com>
Co-authored-by: mffap <mpa@caos.ch>
Co-authored-by: Florian Forster <florian@caos.ch>
2021-09-23 10:34:06 +02:00
Max Peintner
ec6a3a1847
chore(docs): update deps (#2335) 2021-09-07 21:17:07 +02:00
Florian Forster
6fa3076f74
docs: update to beta 3 (#1984) 2021-07-07 07:19:44 +00:00
Florian Forster
bde22e0fde
chore(deps): update docusaurus (#1739) 2021-05-19 06:39:48 +02:00
Florian Forster
dfc9488bb5
docs: rework documentation site (#1589)
* initial commit

* inital changes

* commit WIP Information Architecture

* commit a working state

* add static assets and project

* add org and fix img names

* add plausible

* remove img

* change sidebar to easier mgmt

* add openid oauth and domains

* lint md

* quickstarts

* add auth flow

* identity brokering

* remove site

* fix broken links

* extend footer

* extend readme

* fix: styling

* fix: zitadel logo on index

* styling

* border

* fix: nav

* fix: nav

* fix: index

* fix: rename architecture to concepts

* fix: introductions

* fix: introductions

* fix: introductions

* fix: get started

* fix: user manual

* fix: zitadel architecture

* fix: dead links

* add favicon

Co-authored-by: fabi <fabienne.gerschwiler@gmail.com>
Co-authored-by: Livio Amstutz <livio.a@gmail.com>
2021-04-15 13:22:37 +02:00