search

element-hq / element-meta

Shared/meta documentation and project artefacts for Element clients
75 stars 12 forks source link

[Story] EX: UX Redesign of Settings > Encryption #2590

Open mxandreas opened 1 month ago

mxandreas commented 1 month ago

Description

The UX of setting up a recovery (key) and turning OFF/ON the server-side key storage has been revisited with the main purpose is to allow the end users to make a much better sense of it.

The designs have been revisited cross-platform, both EW and EX, and it is desired that the implementation of those are not too far apart; this story only applies to EX as the starting point for EW and EX is different. EW needs to do structural changes to Settings while EX only needs to change the copy and minor visual aspects.

The scope is the Settings > Encryption (currently Chat backup) menu which has 3 scenarios from user perspective:

The sub-menu End-to-End Encryption with the functions to Export / Import Keys and Reset end-to-end encryption is currently not in scope.

Acceptance criteria

Leads

Size estimate

None

Dependencies

Out of scope

Open questions

### Questions

Subtasks

### Android
- [ ] https://github.com/element-hq/element-x-android/issues/3737
- [ ] https://github.com/element-hq/element-x-android/issues/3738
- [ ] https://github.com/element-hq/element-x-android/issues/3739
### iOS
- [ ] https://github.com/element-hq/element-x-ios/issues/3446
- [ ] https://github.com/element-hq/element-x-ios/issues/3447
- [ ] https://github.com/element-hq/element-x-ios/issues/3448
### Rust
### Other
- [ ] The help page needs to be updated accordingly: https://element.io/help#encryption

Sign-off

Android

iOS

mxandreas commented 1 month ago

cc @manuroe

bmarty commented 3 weeks ago

@mxandreas done on Android with https://github.com/element-hq/element-x-android/pull/3750, can you please check the video there and confirm that it matches what you are expecting?

@americanrefugee please let me know if I missed anything. Thanks!

americanrefugee commented 3 weeks ago

I noticed one thing: After generating/saving the recovery key and clicking "Done", the user should see this confirmation page.

americanrefugee commented 3 weeks ago

Sorry, one more thing:

After setting up the recovery key, the Settings menu item should simply say "Change recovery key" without any additional help text.

At least that's what was designed. @mxandreas do you agree?

mxandreas commented 3 weeks ago

At least that's what was designed. @mxandreas do you agree?

So, the additional help text should only be removed "for a moment" after the setup. If you come back later to the Encryption settings, then the help text should be there again?

I do not mind that, but I am curious what is the reasoning for this? It is not obvious for me.

bmarty commented 3 weeks ago

I noticed one thing: After generating/saving the recovery key and clicking "Done", the user should see this confirmation page.

@americanrefugee the dialog is displayed if the user does not click on the button to copy the key. See below:

https://github.com/user-attachments/assets/1916def5-ab19-4afe-8dfc-b94cdf3b7102

Do you want this dialog to always be displayed?

americanrefugee commented 3 weeks ago

So, the additional help text should only be removed "for a moment" after the setup. If you come back later to the Encryption settings, then the help text should be there again?

I do not mind that, but I am curious what is the reasoning for this? It is not obvious for me.

On second thought, I guess it doesn't make sense to remove the help text. I shall add it back in the design.

the dialog is displayed if the user does not click on the button to copy the key.

Ah, I forgot about that nuance. Let's keep it as you've implemented it. Sorry for the runaround!

pixlwave commented 3 weeks ago

The changes are now available on the latest iOS Nightly (744).