TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-08-14 03:37:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add note about required version to zitadel v3 feature documentation (#9683)

Browse Source 
# Which Problems Are Solved

Since were about to merge and publish a first RC of Zitadel V3, there
are some inconsistencies to v2 in the documentation.
Also since zitadel.cloud will not be running v3 yet, there might be some
confusion.
To prevent as much as possible, we want at least be able to point out
which version is required.

# How the Problems Are Solved

Added a note on the actions v2 and webkeys documentations that it
requires Zitadel v3, resp. that it documents the state of that version.
Added the same note to the hosted login v2 description, since some
features are only supported in v3.

# Additional Changes

None

# Additional Context

Relates to the upcomming merge of v3 to main / release of the first RC.
This commit is contained in:
Livio Spring
2025-04-02 15:18:47 +02:00
committed by GitHub
parent 71765c2152
commit 2b542be851
3 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docs/guides/integrate/login/hosted-login.mdx
View File

@@ -138,6 +138,10 @@ In this initial release, the new login is available for self-hosting only. We'll
### Current State
:::info
The documentation describes the state of the feature in ZITADEL V3.
:::
Our primary goal for the TypeScript login system is to replace the existing login functionality within Zitadel Core, which is shipped with Zitadel automatically. This will allow us to leverage the benefits of the new system, including its modular architecture and enhanced security features.
To achieve this, we are actively working on implementing the core features currently available in Zitadel Core, such as:

1
docs/docs/guides/integrate/login/oidc/webkeys.md
View File

@@ -23,6 +23,7 @@ endpoints are called with a JWT access token.
:::info
Web keys are an [experimental](/docs/support/software-release-cycles-support#beta) feature. Be sure to enable the `web_key` [feature](/docs/apis/resources/feature_service_v2/feature-service-set-instance-features) before using it.
The documentation describes the state of the feature in ZITADEL V3.
Test the feature and add improvement or bug reports directly to the [github repository](https://github.com/zitadel/zitadel) or let us know your general feedback in the [discord thread](https://discord.com/channels/927474939156643850/1329100936127320175/threads/1332344892629717075)!
:::

4
docs/sidebars.js
View File

@@ -761,7 +761,7 @@ module.exports = {
"\n"+
"The public key endpoint (outside of this service) is used to retrieve the public keys of the active and inactive keys.\n"+
"\n"+
"Please make sure to enable the `web_key` feature flag on your instance to use this service.",
"Please make sure to enable the `web_key` feature flag on your instance to use this service and that you're running ZITADEL V3.",
},
items: sidebar_api_webkey_service_v2
},
@@ -782,7 +782,7 @@ module.exports = {
"ZITADEL doesn't restrict the implementation languages, tooling and runtime for v2 action executions anymore.\n" +
"Instead, it calls external endpoints which are implemented and maintained by action v2 users.\n"+
"\n" +
"Please make sure to enable the `actions` feature flag on your instance to use this service.",
"Please make sure to enable the `actions` feature flag on your instance to use this service and that you're running ZITADEL V3.",
},
items: [
{