Adding QA Guide to DevDocs - #1687
Open
traviswindsormoodle wants to merge 10 commits into
Open
Conversation
✅ Deploy Preview for moodledevdocs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new QA Testing section to the Moodle DevDocs Docusaurus site, including a landing page and several starter guides aimed at first-time QA cycle participants.
Changes:
- Adds a new “QA Testing guides” category to the main docs sidebar, backed by an autogenerated
docs/qatesting/section and a category index doc. - Introduces new QA testing documentation pages (Getting Started, Common Terms, FAQ) plus a landing page.
- Updates the project spelling/word list to include “Lomman”.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars/docs.js | Adds a new “QA Testing guides” sidebar category with autogenerated items and a category index doc. |
| project-words.txt | Adds a custom dictionary word used in the new QA docs. |
| docs/qatesting.md | New landing page for the QA Testing guides section. |
| docs/qatesting/gettingstarted.md | New getting-started guide, including templates and a referenced image. |
| docs/qatesting/commonterms.md | New short glossary page for common QA testing terms. |
| docs/qatesting/faq.md | New FAQ page for first-time testers, including links to forums/dashboards. |
Suppressed comments (2)
docs/qatesting/faq.md:80
- This Testing & QA forum link is missing the forum id query parameter (should match the existing DevDocs link to the Testing and QA forum:
view.php?id=56).
- The [Testing & QA forum](https://moodle.org/mod/forum/view.php) is actively watched, and a good place to subscribe so you know when a new cycle opens.
docs/qatesting/faq.md:93
- Link text includes a "(update later)" placeholder, which reads like unfinished content. Please remove the placeholder text (or replace it with a stable label).
Visit the QA testing dashboard — [Moodle 5.3 QA testing (update later)](https://moodle.atlassian.net/jira/dashboards/10612) — to explore the full list of tests. For example, if you want tests for the "Book" activity aimed at "Teachers", you can [filter by those components](https://moodle.atlassian.net/issues/).
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Updated link to the Getting Started guide in FAQ.
Updated the opening date for the Moodle 5.3 QA cycle.
Fixed the rendering of the templates to match the original confluence. It's not perfect, but closest that's possible before changing css of the dropdowns
Updated instructions for setting up accounts and running tests, clarified steps and links, and improved overall readability.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.