Commit Graph

26 Commits

Author SHA1 Message Date
Fabienne Bühler
b8ff83454e docs: product roadmap and zitadel versions (#9838)
# Which Problems Are Solved

The current public roadmap can be hard to understand for customers and
it doesn't show the timelines for the different versions. which results
in a lot of requests.
It only outlines what is already fixed on the timeline, but doesn't give
any possibilities to outline future topics / features, which not yet
have a timeline

# How the Problems Are Solved

A new roadmap page is added
- Outline for each version when it will have which state
- Outline different zitadel versions with its features, deprecations,
breaking changes, etc.
- Show future topics, which are not yet on the roadmap
2025-06-03 13:44:04 +00:00
Elio Bischof
88493dd2a0 docs: strikethrough deprecated APIs (#9740)
# Which Problems Are Solved

The docs overview pages and navs don't visually distinguish between
deprecated and GA APIs.
This makes it hard to find the right methods for the job already.
As we are implementing the resource API and continously deprecate
obsolete APIs, this only gets worse.

# How the Problems Are Solved

The UI items in docs overview pages are striked through and pushed to
the bottom of the list.
This applies to side navs as well as card lists.

For example, [see management user
methods](https://docs-git-strikethrough-deprecated-apis-zitadel.vercel.app/docs/apis/resources/mgmt/users):

![image](https://github.com/user-attachments/assets/a12ccd92-3a70-4854-8ebf-b771ff151083)

A method is considered deprecated if it has this option set in the
protos rpc definition:

```protobuf
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
    deprecated: true;
}
```

# Additional Changes

None

# Additional Context

- Relates to #9680

---------

Co-authored-by: David Skewis <david@zitadel.com>
2025-04-14 11:37:47 +00:00
mffap
383b68b48f docs: add video to quickstart (#7512) 2024-03-06 18:31:49 +00:00
Fabi
a065ddc706 docs: Make Examples and SDK Pages easier to understand (#7291)
* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: adding more example pages

* docs: adding more example pages

* docs: add all sdk/examples

* docs: add tile component

* docs: introduction page

* docs: introduction page

* docs: add react

* docs: remove old sdk and example pages

* docs: fix broken links

* docs: fix broken links

* styles

* Update docs/docs/sdk-examples/introduction.mdx

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

* Update docs/docs/sdk-examples/java.mdx

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

* Update docs/docs/sdk-examples/python.mdx

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

* Update docs/docs/sdk-examples/python.mdx

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

* docs: review changes

* docs: smaller tiles

* docs: changes from go and java review

* docs: correct python description

* Update docs/docs/sdk-examples/python.mdx

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

* Update docs/docs/sdk-examples/introduction.mdx

Co-authored-by: Tim Möhlmann <tim+github@zitadel.com>

* Update docs/docs/sdk-examples/python.mdx

Co-authored-by: Tim Möhlmann <tim+github@zitadel.com>

* docs: flask logo

* flask, rust imgs

* docs: flask logo

* Update go.mdx

* Update java.mdx

* Update docs/docs/sdk-examples/flutter.mdx

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

* Update docs/src/css/tile.module.css

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

* docs: sidebar alphabetic

* docs: sidebar alphabetic

* docs: django logo

---------

Co-authored-by: peintnermax <max@caos.ch>
Co-authored-by: Livio Spring <livio.a@gmail.com>
Co-authored-by: Tim Möhlmann <tim+github@zitadel.com>
Co-authored-by: Stefan Benz <stefan@caos.ch>
2024-02-07 12:44:20 +01:00
mffap
bd5506494a docs(legal): update legal framework and policies (November 2023) (#6611)
* move policies

* service description editorial

* service description move

* add subprocessors

* resort policies and service descriptions

* subprocessor

* subprocessors wip

* wip

* subprocessors

* subprocessors introduction

* billing wip

* service level headings

* billing wip

* gdpr region clarification

* fix some styling

* support service wip

* wip

* service-description

* fair use, broken links

* services offered

* rework enterprise benefits

* support plans

* remove language, add support issue

* combine onboarding support

* wip

* use of brand and trademarks

* sidebar

* DASU

* Combine ToS for support services

* Apply suggestions from code review

Co-authored-by: Fabi <fabienne@zitadel.com>

* changes from review

* update updatedAt

* dpa and pp updates WIP

* broken links

* tom

* remote entity

* title annex enterprise agreement

* typo

* Apply suggestions from code review

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

* update last update dates

* replace quota with amount

---------

Co-authored-by: Fabi <fabienne@zitadel.com>
Co-authored-by: Florian Forster <florian@zitadel.com>
2023-11-16 09:26:25 +00:00
mffap
0431cd15f9 docs(scenarios): domain discovery (#5688)
* formatting title configuration

* color generated boxes

* structure

* move saas

* overview

* add integration overview (fixes broken  link on main page)

* instance settings

* user journeys

* fix broken link to saas

* instance considerations

* orgs

* organizations update

* instance settings: domain settings

* heading

* verification and conclusion

* fix diagram

* default org behavior from review
2023-04-21 14:54:32 +00: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
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
1b868b6a7f docs: nextjs b2b example, plausible outbound links script (#4738)
* b2b example, link from b2b solution scenario, cleanup nextjs doc

* b2b md

* repo link

* add plausible outbound events

* update examples link
2022-11-23 13:27:09 +00: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
Max Peintner
7c49f03d19 docs: welcome gigi (#4159)
* docs: welcome gigi

* light theme

* foreground

* banner on readme

Co-authored-by: mffap <mpa@zitadel.com>
Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>
2022-08-11 07:32:50 +00:00
Jay
0ffdc97301 Docs UI (#3901)
* test css change

for max to have a look

* changed a font color

(just a test for git push)

* changing some UI colors according to CI/CD colors

* changing font color hero button

Co-authored-by: Jay <juerg.rinaldi@gmail.com>
2022-07-14 09:43:36 +00:00
Fabi
0c14614d02 docs: Docs v2 (#3733)
* fix: change images

* fix: change images, add policies

* fix: change images, add policies

* docs: add customer portal docs

* docs: add customer portal docs

* docs: add customer portal docs

* docs: add customer portal docs

* docs: organization creation

* docs: policy docs

* docs: change password

* docs: verify domain

* docs: profile page

* docs: profile page

* docs: profile page

* docs: login page

* docs: login page

* docs: fix broken links

* docs: customer portal users

* docs: instance detail

* docs: instance detail

* docs: getting started

* Update organizations.mdx

Co-authored-by: Livio Amstutz <livio.a@gmail.com>
2022-06-02 12:05:45 +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
46ff51b631 docs: local assets (#3151) 2022-02-02 13:45:01 +01:00
Max Peintner
22c9cf99e7 docs: update deps, fix zitadel logo size (#3122) 2022-01-31 13:36:16 +01:00
Max Peintner
68827dfdcd docs: styling, concepts cleanup (#2643)
* Architecture Scenarios B2B B2C

* b2b b2c

* cleanup concepts

* homepage links, b2c docs

* b2c, new homepage, custom components

* more content

* fix rxjs

* temp remove architecture scenarios

* temp remove architecture scenarios

* Update docs/src/pages/index.js

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

* update docusaurus & review scenarios

* refactor user login guide (#2921)

* Update docs/docs/guides/architecture-scenarios/b2b.mdx

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

* Update docs/docs/guides/architecture-scenarios/b2b.mdx

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

* Update docs/docs/guides/architecture-scenarios/b2b.mdx

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

* Update docs/docs/guides/architecture-scenarios/b2b.mdx

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

* Update docs/docs/guides/architecture-scenarios/b2c.mdx

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

* Update docs/docs/guides/architecture-scenarios/b2c.mdx

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

* Update docs/docs/guides/architecture-scenarios/b2b.mdx

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

* Update docs/docs/guides/architecture-scenarios/b2b.mdx

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

* Update docs/docs/guides/architecture-scenarios/b2b.mdx

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

* Update docs/docs/guides/architecture-scenarios/b2c.mdx

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

* Update docs/docs/guides/architecture-scenarios/b2c.mdx

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

* Update docs/docs/guides/architecture-scenarios/b2c.mdx

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

* user-login splitup

* files

* organize files

* cleanup authmethods

* solution scenarios

* add link to authz

* Update docs/docs/guides/authentication/authmethods/implicit.mdx

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

* Update docs/docs/guides/authentication/authmethods/implicit.mdx

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

* fix broken links

* Update docs/docs/guides/solution-scenarios/b2c.mdx

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

* c for consumer

Co-authored-by: Florian Forster <florian@caos.ch>
Co-authored-by: Fabi <38692350+fgerschwiler@users.noreply.github.com>
Co-authored-by: mffap <mpa@caos.ch>
Co-authored-by: Livio Amstutz <livio.a@gmail.com>
2022-01-11 20:48:13 +01:00
Max Peintner
8df5614e4d docs(apis): cleanup navigation, better overview (#2608)
* api cards, cleanup overview

* endpoint, definition shortcuts, links

* update quickstart links

* mobile overflow

* Update docs/docs/apis/introduction.mdx

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

* Update docs/docs/apis/introduction.mdx

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

Co-authored-by: Florian Forster <florian@caos.ch>
2021-11-02 14:05:47 +01:00
Max Peintner
153c9054ad docs: overview in help, legal section (#2532)
* help, legal section

* Update docs/docs/legal/introduction.mdx

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

Co-authored-by: Florian Forster <florian@caos.ch>
2021-10-21 17:02:25 +02:00
Max Peintner
13d0a9754c docs: quickstart, guides overview (#2524)
* fix: components, styles

* col component

* list components, change contents

* fix link
2021-10-18 19:37:29 +00:00
Max Peintner
623c8e58b8 fix: add :not pseudo (#2507) 2021-10-13 15:17:24 +02:00
Max Peintner
591a460450 docs: rehaul styles (#2505)
* doc config

* css

* assets

* header color

* transparent navbar

* prettier success colors

* smaller navitems

* table, toast styles

* more toast colors
2021-10-13 10:06:12 +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
Fabi
12f128e3c5 docs: api request descriptions (#1637)
* doc: api descriptions

* doc: management description

* doc: message validation

* doc: api descriptions

* doc: api descriptions

* doc: description

* doc: index images

* doc: design

* colors, colors and more colors

* margin

* fix comment

* doc: api descriptions

* doc: empty response

* doc: api descriptions

* fix comment

Co-authored-by: Livio Amstutz <livio.a@gmail.com>
2021-04-22 12:59:17 +00: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