TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-06-11 08:48:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: technical advisory 1002 - MDC components (#6487)

Browse Source 
* draft console mdc component advisory

* pr

* textual change
This commit is contained in:
Max Peintner 2023-09-04 14:51:37 +02:00 committed by GitHub
parent e3e17fe742
commit 7d6e483393
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 65 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/docs/support/advisory/a10002.md Normal file
View File

@ -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.

48
docs/docs/support/technical_advisory.mdx
View File

@ -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.
<table>
<tr>
<th>Advisory</th>
@ -19,21 +18,55 @@ We understand that these advisories may include breaking changes, and we aim to
<th>Date</th>
</tr>
<tr>
<td><a href="./advisory/a10000">A-10000</a></td>
<td>
<a href="./advisory/a10000">A-10000</a>
</td>
<td>Reusing user session</td>
<td>Breaking Behaviour Change</td>
<td>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.</td>
<td>
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.
</td>
<td>2.32.0</td>
<td>Calendar week 32</td>
</tr>
<tr>
<td><a href="./advisory/a10001">A-10001</a></td>
<td>
<a href="./advisory/a10001">A-10001</a>
</td>
<td>Login Policy - Allow Register</td>
<td>Breaking Behaviour Change</td>
<td>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.</td>
<td>
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.
</td>
<td>TBD</td>
<td>Calendar week 34/35</td>
</tr>
<tr>
<td>
<a href="./advisory/a10002">A-10002</a>
</td>
<td>Console - Branding</td>
<td>Breaking Design Change</td>
<td>
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.
</td>
<td>TBD</td>
</tr>
</table>
## 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.