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 docs links to the page settings #7488

Merged
merged 2 commits into from Feb 21, 2024
Merged

Conversation

m1r0
Copy link
Member

@m1r0 m1r0 commented Feb 20, 2024

Proposed Changes

To help users better understand how to use the page settings, this PR adds docs links to the settings description.

Context

p1708014451312029-slack-C02P7FHLVR9

Testing Instructions

  1. Go to Sensei LMS -> Settings -> General.
  2. Check that the "Course Archive Page" setting has a link to this doc.
  3. Check that the "My Courses Page" setting has a link to this doc.
  4. Check that the "Course Completed Page" setting has a link to this doc.

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

@m1r0 m1r0 added this to the 4.20.3 milestone Feb 20, 2024
@m1r0 m1r0 self-assigned this Feb 20, 2024
@m1r0 m1r0 force-pushed the add/doc-links-to-page-settings branch from 06c6f35 to 87efcb8 Compare February 20, 2024 15:34
Copy link

codecov bot commented Feb 20, 2024

Codecov Report

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

Comparison is base (27192b3) 51.26% compared to head (884ae10) 51.45%.
Report is 2 commits behind head on trunk.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##              trunk    #7488      +/-   ##
============================================
+ Coverage     51.26%   51.45%   +0.18%     
- Complexity    11189    11203      +14     
============================================
  Files           614      622       +8     
  Lines         47259    47408     +149     
  Branches        407      414       +7     
============================================
+ Hits          24229    24394     +165     
+ Misses        22703    22681      -22     
- Partials        327      333       +6     
Files Coverage Δ
includes/class-sensei-settings.php 60.26% <100.00%> (+0.32%) ⬆️
includes/class-sensei-settings-api.php 25.95% <0.00%> (ø)

... and 1 file 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 429ad33...884ae10. Read the comment docs.

@m1r0 m1r0 marked this pull request as ready for review February 20, 2024 15:41
@m1r0 m1r0 requested a review from a team February 20, 2024 15:41
Copy link
Member

@merkushin merkushin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

Maybe we need to update the docs (or at least add a corresponding label). Currently, the docs say about the purpose of each page, but they don't say that we can't use the same page for everything. WDYT?

@m1r0
Copy link
Member Author

m1r0 commented Feb 21, 2024

Thanks, Dmitry.

Currently, the docs say about the purpose of each page, but they don't say that we can't use the same page for everything. WDYT?

cc @jinnypark because she added the docs.

@m1r0 m1r0 merged commit 5484f86 into trunk Feb 21, 2024
23 of 24 checks passed
@m1r0 m1r0 deleted the add/doc-links-to-page-settings branch February 21, 2024 16:44
@jinnypark
Copy link
Member

@m1r0 and @merkushin - the doc is in progress, but I have limited time to continue updating them. I ran out of time, so it's kind of in a 'draft'. I won't have time until tomorrow at the earliest to do more updates, so feel free to update them! We can continue conversations about docs update to this issue: https://github.com/Automattic/jpop-satellite-docs/issues/193

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants