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 question bank filter API guide #1199

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

marxjohnson
Copy link
Contributor

This functionality was added in MDL-72321. MDL-78220 will add several new filters, so this guide may expand as the children of that tracker are developed.

Copy link

netlify bot commented Dec 3, 2024

Deploy Preview for moodledevdocs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit d7c52b5
🔍 Latest deploy log https://app.netlify.com/sites/moodledevdocs/deploys/677fe48991be2100088b6794
😎 Deploy Preview https://deploy-preview-1199--moodledevdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

github-actions bot commented Dec 3, 2024

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🔴 39 🟢 95 🟢 100 🟢 90 🟢 100 Report
/docs/5.0/apis/commonfiles 🔴 42 🟢 93 🟢 100 🟢 100 🟢 100 Report
/general/development/gettingstarted 🟠 51 🟢 95 🟢 100 🟢 90 🟢 100 Report
/general/releases 🟠 64 🟢 95 🟢 100 🟢 100 🟢 100 Report

Copy link
Collaborator

@timhunt timhunt left a comment

Choose a reason for hiding this comment

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

Thanks Mark. This looks like a good start to documenting this.

@timhunt
Copy link
Collaborator

timhunt commented Dec 3, 2024

Ah! but I see taht the automated checks need to be appeased.

@marxjohnson marxjohnson force-pushed the question-bank-filters branch 2 times, most recently from ce8e3fb to 606e80b Compare December 3, 2024 15:09
Copy link
Member

@andrewnicols andrewnicols left a comment

Choose a reason for hiding this comment

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

These docs look generally great. I've left a few comments -- see what you think.

Since these are docs for a 4.3 feature we should backport to 4.3 and 4.4 using the versioned_docs folders. If you need help with this I can do this on the PR -- just let me know.

Thanks

docs/apis/plugintypes/qbank/filters.md Outdated Show resolved Hide resolved
docs/apis/plugintypes/qbank/filters.md Outdated Show resolved Hide resolved
docs/apis/plugintypes/qbank/filters.md Outdated Show resolved Hide resolved
docs/apis/plugintypes/qbank/filters.md Outdated Show resolved Hide resolved
This functionality was added in MDL-72321. MDL-78220 will add several
new filters, so this guide may expand as the children of that tracker
are developed.
@marxjohnson marxjohnson force-pushed the question-bank-filters branch 2 times, most recently from e8991b3 to 6ccef35 Compare January 9, 2025 14:41
Add titles and fix indentation in code blocks.
Add parentheses to function references.
Change GitHub links to point to entire files.
Re-word and re-order sections to make it clearer which parts are
compulsory and which are optional.
@marxjohnson marxjohnson force-pushed the question-bank-filters branch from 6ccef35 to d7c52b5 Compare January 9, 2025 15:00
@marxjohnson
Copy link
Contributor Author

@andrewnicols Thanks for your comments, I have made those changes and re-worked the ordering of things a bit to make it clearer which bits are compulsory, and which are more advanced. I've included those changes as fixups so I can squash them if you're happy.

I've also added an extra commit to cover the validation support I've added in MDL-83862.

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.

4 participants