-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Remove outdated recovery setup options from E2EE docs #30681
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Deprecation means still available but will be removed soon, this doesn't look like a valid deprecation which should have happened before their removal? EW still seems to read the 2 fields you specified. It seems like the only codepath which still respects them is the force reset flow which can be accessed via Restore Key Backup -> Reset Recovery |
Ideally yes, however, the change here is in the user/UI behavior and UI is continuously updated in the apps without any deprecation warnings (whether config settings are involved in this behavior or not, does not matter much). I think the only thing to be changed here now is to use "removed" instead of "deprecated" as I agree it can be misleading.
Is this still accessible somewhere on the UI? |
Only accessible when the |
I think this path got overlooked when we were updating the other Recovery setup flows (in #29232, I think). It's related to #29171. In any case, the fact that that specific flow honours the old settings should be considered a bug, not a feature. |
Agreed, but the documentation should match reality, and not state something to the effect of "these options don't work anymore" |
Co-authored-by: Richard van der Hoff <[email protected]>
Co-authored-by: Richard van der Hoff <[email protected]>
Co-authored-by: Richard van der Hoff <[email protected]>
The documentation should help the user, so the question is who and how would mentioning of the "CryptoEvent.KeyBackupFailed event fires". If you have a clear idea about that in mind, please suggest the corresponding update. |
Users can't change the config, only admins of a given Element Web instance can, so not sure why users would be reading this documentation. User-facing documentation lives on https://docs.element.io/ |
I consider admins also users. Why is it important for them to know that some part of code is still accessing some of these configuration options? |
Because the change makes it sound like they can leave their config and it has zero effect anymore, when in reality it does still have effect, just in rare cases, and if they want consistency they would need to remove it. |
Yes, but then we have to be able to explain it to them in the language they understand - what's the impact to the behavior. Right now this is not fully clear to me, and that is why I am asking. |
The impact is: the docs apply, except in certain cases where they are a lie, yielding confusion and no clear reason for them to remove their existing configuration which apparently does nothing anymore. We should just rip out the edge case which still uses the config, it could have probably been done in the time we've spent debating it. |
I did not mean this "impact", I meant "impact" of what happens when the admins do not remove the settings: where, when and what kind of weird things the users are going to see.
In my view this should not have blocked the updates to the docs (in their current form) at all, because the current version is way more worse and confusing. I'll see with @richvdh how we proceed. |
Where: in the app |
CI failed due to #28836 |
* Deprecate secure_backup_required and secure_backup_setup_methods in docs. * Wording enhancements. Co-authored-by: Richard van der Hoff <[email protected]> * Use removal, not deprecation for sake of clarity. Co-authored-by: Richard van der Hoff <[email protected]> * Use removal, not deprecation for sake of clarity. Co-authored-by: Richard van der Hoff <[email protected]> * prettier --------- Co-authored-by: Richard van der Hoff <[email protected]> Co-authored-by: Richard van der Hoff <[email protected]>
…required` & `secure_backup_setup_methods`) from `/.well-known/matrix/client` Ref: - element-hq/element-web#30681 - element-hq/element-web#30702
The configuration options
secure_backup_required
andsecure_backup_setup_methods
are no longer available. This was not yet reflected in the docs.Checklist
public
/exported
symbols have accurate TSDoc documentation.