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

Update report builder API docs #1196

Merged
merged 9 commits into from
Dec 6, 2024
Merged

Conversation

NeillM
Copy link
Contributor

@NeillM NeillM commented Dec 2, 2024

I have:

  • Added documentation for creating data sources for custom reports
  • Setting filter conditions in code
  • Added some additional tips for creating entities
  • Pointed code examples at the branch of Moodle the docs are for

I have attempted to ensure that the docs include API changes that have happened since Moodle 4.3

This change should hopefully implement most of the improvements I think would be useful in Issue #1192

The first part seems to be more of an overview of how the report builder API is structured,
and how those parts should be used, before talking about how to specifically use it in
system reports.
We are also detqailing how to write unit tests for them so that any errors
can be found before they go into production
If we do not do this users may see and use features that are not part of the Moodle version they are coding for
Copy link

netlify bot commented Dec 2, 2024

Deploy Preview for moodledevdocs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit ac1cb31
🔍 Latest deploy log https://app.netlify.com/sites/moodledevdocs/deploys/674dd8849a3ac100084b4c8c
😎 Deploy Preview https://deploy-preview-1196--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.

@NeillM
Copy link
Contributor Author

NeillM commented Dec 2, 2024

I think that the issue is that on Windows if you run yarn lint-staged on something like ./filter.md it will be converted to a path like \docs\apis\core\reportbuilder\filtering.md, when in fact it should be /docs/apis/core/reportbuilder/filtering.md

They were being forced to use Windows style slashes and a full path when I ran `yarn lint-staged`
Copy link
Contributor

github-actions bot commented Dec 2, 2024

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 87 🟢 95 🟢 100 🟢 90 🟢 100 Report
/docs/5.0/apis/commonfiles 🟠 69 🟢 93 🟢 100 🟢 100 🟢 100 Report
/general/development/gettingstarted 🟠 77 🟢 95 🟢 100 🟢 90 🟢 100 Report
/general/releases 🟠 66 🟢 95 🟢 100 🟢 100 🟢 100 Report

@paulholden
Copy link
Contributor

Thanks @NeillM for documenting this - I'll have a look through these

@paulholden paulholden added this pull request to the merge queue Dec 6, 2024
Merged via the queue into moodle:main with commit f949add Dec 6, 2024
7 checks passed
@NeillM
Copy link
Contributor Author

NeillM commented Dec 10, 2024

Thanks Paul

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.

2 participants