-
Notifications
You must be signed in to change notification settings - Fork 198
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
Add HPPS instructions #7420
Add HPPS instructions #7420
Conversation
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## trunk #7420 +/- ##
============================================
+ Coverage 50.96% 51.15% +0.19%
- Complexity 11159 11179 +20
============================================
Files 614 614
Lines 47085 47178 +93
Branches 405 405
============================================
+ Hits 23996 24135 +139
+ Misses 22762 22716 -46
Partials 327 327
... and 17 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking a lot better!
Given this is currently our only experimental feature, WDYT about making those instructions always visible? Currently, as soon as you check the box, step 1 is already technically fulfilled so people may wonder "Well, didn't I just do that?" And I think there may be a step missing to enable the sync option?
I think we could also make the steps even more explicit. For example, something like:
- Select the "High-Performance Progress Storage" checkbox.
- Save the changes.
- Select the "Progress storage synchronization" checkbox.
- Save the changes.
- Wait until the "Migration complete and data synchronization enabled" message is displayed. This may take awhile and you will need to refresh the page to see the updated status.
- Select the "High-Performance progress storage (experimental)" option."
- Save the changes.
- You are now using High-Performance Progress Storage!
The save steps could also be part of the previous step if we want to make it more concise.
Could we also reorder the steps so that they match the order the user should enable them in? So "Progress storage synchronization" would go before "Progress storage repository".
Oops, didn't mean to approve. 😅 |
Thanks for the input, @donnapep!
Yep, makes sense. I've updated the instructions in ee779b6. Here's a quick screenshot. I've also added an extra step for actually enabling the feature but let me know if that's too much. The "save the changes" part looks a bit repetitive and kinda obvious. Should we leave it in?
I'm guessing you've misread the first step in the initial instuctions. It's for enabling the sync. 🙂 |
It is, but I think it's important to mention it since I've noticed myself missing the Save button on occasion. We could trim it down to just "save" though. I'm wondering about this bit?
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dropped a comment #7420 (comment), otherwise 👍🏻 .
Do you mean to change the order of the settings? If that's the case, I've updated it in a62fe37. |
Resolves #7415
Proposed Changes
This PR adds HPPS instructions to the settings screen. It also adds a link to the future docs page.
Testing Instructions
Pre-Merge Checklist