Skip to content
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

Merged
merged 4 commits into from Jan 17, 2024
Merged

Add HPPS instructions #7420

merged 4 commits into from Jan 17, 2024

Conversation

m1r0
Copy link
Member

@m1r0 m1r0 commented Jan 4, 2024

Resolves #7415

Proposed Changes

This PR adds HPPS instructions to the settings screen. It also adds a link to the future docs page.

jsWU9w.png

Testing Instructions

  1. Go to Sensei LMS -> Settings -> Experimental Features
  2. Enable the HPPS feature.
  3. You should see the instructions.

Pre-Merge Checklist

  • PR title and description contain sufficient detail and accurately describe the changes
  • Acceptance criteria is met
  • Decisions are publicly documented
  • Adheres to coding standards (PHP, JavaScript, CSS, HTML)
  • All strings are translatable (without concatenation, handles plurals)
  • Follows our naming conventions (P6rkRX-4oA-p2)
  • Hooks (p6rkRX-1uS-p2) and functions are documented
  • New UIs are responsive and use a mobile-first approach
  • New UIs match the designs
  • Different user privileges (admin, teacher, subscriber) are tested as appropriate
  • Legacy courses (course without blocks) are tested
  • Code is tested on the minimum supported PHP and WordPress versions
  • User interface changes have been tested on the latest versions of Chrome, Firefox and Safari
  • "Needs Documentation" label is added if this change requires updates to documentation
  • Known issues are created as new GitHub issues

Copy link

codecov bot commented Jan 4, 2024

Codecov Report

Attention: 16 lines in your changes are missing coverage. Please review.

Comparison is base (1d0f103) 50.96% compared to head (a62fe37) 51.15%.
Report is 98 commits behind head on trunk.

Additional details and impacted files

Impacted file tree graph

@@             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              
Files Coverage Δ
assets/shared/query-string-router/index.js 90.47% <100.00%> (ø)
.../class-sensei-home-task-customize-course-theme.php 90.00% <100.00%> (+18.57%) ⬆️
includes/class-sensei-usage-tracking-data.php 99.62% <100.00%> (ø)
includes/class-sensei-utils.php 52.70% <100.00%> (-0.09%) ⬇️
...udes/internal/emails/class-email-page-template.php 75.00% <100.00%> (ø)
...ernal/emails/generators/class-course-completed.php 100.00% <100.00%> (ø)
...ncludes/course-theme/class-sensei-course-theme.php 18.59% <0.00%> (ø)
includes/class-sensei-admin.php 19.02% <0.00%> (ø)
includes/class-sensei-settings.php 59.93% <47.05%> (-0.50%) ⬇️

... and 17 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d38577f...a62fe37. Read the comment docs.

@m1r0 m1r0 marked this pull request as ready for review January 4, 2024 19:07
@m1r0 m1r0 requested a review from a team January 4, 2024 19:08
@m1r0 m1r0 self-assigned this Jan 4, 2024
donnapep
donnapep previously approved these changes Jan 8, 2024
Copy link
Collaborator

@donnapep donnapep left a 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:

  1. Select the "High-Performance Progress Storage" checkbox.
  2. Save the changes.
  3. Select the "Progress storage synchronization" checkbox.
  4. Save the changes.
  5. 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.
  6. Select the "High-Performance progress storage (experimental)" option."
  7. Save the changes.
  8. 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".

@donnapep donnapep self-requested a review January 8, 2024 16:24
@donnapep
Copy link
Collaborator

donnapep commented Jan 8, 2024

Oops, didn't mean to approve. 😅

@m1r0
Copy link
Member Author

m1r0 commented Jan 8, 2024

Thanks for the input, @donnapep!

Given this is currently our only experimental feature, WDYT about making those instructions always visible?

Yep, makes sense. I've updated the instructions in ee779b6. Here's a quick screenshot.

xz0iaL.png

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?

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'm guessing you've misread the first step in the initial instuctions. It's for enabling the sync. 🙂

@donnapep
Copy link
Collaborator

The "save the changes" part looks a bit repetitive and kinda obvious. Should we leave it in?

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?

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

donnapep
donnapep previously approved these changes Jan 12, 2024
Copy link
Collaborator

@donnapep donnapep left a 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 👍🏻 .

@m1r0
Copy link
Member Author

m1r0 commented Jan 15, 2024

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

Do you mean to change the order of the settings? If that's the case, I've updated it in a62fe37.

@m1r0 m1r0 merged commit a497057 into trunk Jan 17, 2024
24 checks passed
@m1r0 m1r0 deleted the add/hpps-instructions branch January 17, 2024 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Investigate how to simplify the enabling of HPPS
2 participants