Skip to content

Conversation

@OfficialJhimmy
Copy link

No description provided.

@OfficialJhimmy
Copy link
Author

OfficialJhimmy commented Apr 15, 2025

This pull request migrates over the documentation for the Reports Component in the reStructuredText (RST) format. It addresses #199.

@RCheesley RCheesley self-requested a review April 22, 2025 08:45
@favour-chibueze favour-chibueze added the writetechhub Pull requests from writetechhub's team label Apr 22, 2025
Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

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

Thanks for making a start at this @OfficialJhimmy - there's a lot of Vale fixes to address and probably more lurking beneath your use of vale off.

Please remove all of those, and we'll tell you where to use it if it's absolutely necessary.

Shout if you need some help running Vale in your editor, it should have picked all of these up while you were typing!

@@ -1,4 +1,220 @@
Reports
#######
To add and render custom reports in Mautic, your plugin needs to listen to three events:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
To add and render custom reports in Mautic, your plugin needs to listen to three events:
To add and render custom Reports in Mautic, your Plugin needs to listen to three events:

Copy link
Author

Choose a reason for hiding this comment

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

Thank you, I have fixed this.

- ``ReportEvents::REPORT_ON_GENERATE``
- ``ReportEvents::REPORT_ON_GRAPH_GENERATE``

This guide walks you through defining a custom report, generating report data, and rendering graphs.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
This guide walks you through defining a custom report, generating report data, and rendering graphs.
This guide walks you through defining a custom Report, generating Report data, and rendering graphs.

Copy link
Author

Choose a reason for hiding this comment

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

Thank you for this, I have fixed this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

writetechhub Pull requests from writetechhub's team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants