From 7d6e483393b6bb53fab5f1275b98806b7a132353 Mon Sep 17 00:00:00 2001 From: Max Peintner Date: Mon, 4 Sep 2023 14:51:37 +0200 Subject: [PATCH] docs: technical advisory 1002 - MDC components (#6487) * draft console mdc component advisory * pr * textual change --- docs/docs/support/advisory/a10002.md | 25 ++++++++++++ docs/docs/support/technical_advisory.mdx | 48 ++++++++++++++++++++---- 2 files changed, 65 insertions(+), 8 deletions(-) create mode 100644 docs/docs/support/advisory/a10002.md diff --git a/docs/docs/support/advisory/a10002.md b/docs/docs/support/advisory/a10002.md new file mode 100644 index 0000000000..700ab9377d --- /dev/null +++ b/docs/docs/support/advisory/a10002.md @@ -0,0 +1,25 @@ +--- +title: Technical Advisory 10002 +--- + +## Description + +Since Angular Material v15 many of the UI components have been refactored +to be based on the official Material Design Components for Web (MDC). +These refactored components do not support dynamic styling, so in order to keep the library up-to-date, +the console UI will loose its dynamic theming capability. + +## Statement + +This design change is tracked in the following PR: [feat(console): MDC components](https://github.com/zitadel/zitadel/pull/6482). +As soon as the release version is published, we will include the version here. + +## Mitigation + +If you need users to have your branding settings +(background-, button-, link and text coloring), you should implemement your +own user facing UI yourself and not use ZITADELs console UI. Assets like your logo and icons will still be used. + +## Impact + +Once this update has been released and deployed, the console UI won't apply any coloring of your branding settings to the UI components. diff --git a/docs/docs/support/technical_advisory.mdx b/docs/docs/support/technical_advisory.mdx index 355f21a230..37d4988a4d 100644 --- a/docs/docs/support/technical_advisory.mdx +++ b/docs/docs/support/technical_advisory.mdx @@ -2,13 +2,12 @@ title: Technical Advisory --- -Technical advisories are notices that report major issues with ZITADEL Self-Hosted or the ZITADEL Cloud platform that could potentially impact security or stability in production environments. +Technical advisories are notices that report major issues with ZITADEL Self-Hosted or the ZITADEL Cloud platform that could potentially impact security or stability in production environments. These advisories may include details about the nature of the issue, its potential impact, and recommended mitigation actions. -Users are strongly encouraged to evaluate these advisories and consider the recommended mitigation actions independently from their version upgrade schedule. +Users are strongly encouraged to evaluate these advisories and consider the recommended mitigation actions independently from their version upgrade schedule. We understand that these advisories may include breaking changes, and we aim to provide clear guidance on how to address these changes. - @@ -19,21 +18,55 @@ We understand that these advisories may include breaking changes, and we aim to - + - + - + - + + + + + + + +
AdvisoryDate
A-10000 + A-10000 + Reusing user session Breaking Behaviour ChangeThe default behavior for users logging in is to be directed to the Select Account Page on the Login. With the upcoming changes, users will be automatically authenticated when logging into a second application, as long as they only have one active session. No action is required on your part if this is the intended behavior. + The default behavior for users logging in is to be directed to the Select + Account Page on the Login. With the upcoming changes, users will be + automatically authenticated when logging into a second application, as + long as they only have one active session. No action is required on your + part if this is the intended behavior. + 2.32.0 Calendar week 32
A-10001 + A-10001 + Login Policy - Allow Register Breaking Behaviour ChangeWhen disabling the option, users are currently not able to register locally and also not through an external IDP. With the upcoming change, the setting will only prevent local registration. Restriction to Identity Providers can be managed through the corresponding IDP Template. No action is required on your side if this is the intended behaviour or if you already disabled registration on your IDP. + When disabling the option, users are currently not able to register + locally and also not through an external IDP. With the upcoming change, + the setting will only prevent local registration. Restriction to Identity + Providers can be managed through the corresponding IDP Template. No action + is required on your side if this is the intended behaviour or if you + already disabled registration on your IDP. + TBD Calendar week 34/35
+ A-10002 + Console - BrandingBreaking Design Change + Since Angular Material v15 many of the UI components have been refactored + to be based on the official Material Design Components for Web (MDC). + These refactored components do not support dynamic styling, so in order to + keep the library up-to-date, the console UI will loose its dynamic theming + capability. If you need users to have your branding settings (background-, + button-, link and text coloring) you should implemement your own user + facing UI yourself and not use ZITADELs console UI. + TBD
## Subscribe to our Mailing List @@ -51,4 +84,3 @@ A breaking behavior change refers to a modification or update that changes the b This change does not necessarily affect the APIs or any functions you are calling, so it may not require an update to your code. However, if you rely on specific results or behaviors, they may no longer be guaranteed after the change is implemented. Therefore, it is important to be aware of breaking behavior changes and their potential impact on your use of ZITADEL, and to take appropriate action if needed to ensure continued functionality. -