-
Couldn't load subscription status.
- Fork 39
docs: migrated the Reports component from the old docs to the new docs #238
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
base: 5.x
Are you sure you want to change the base?
Conversation
|
This pull request migrates over the documentation for the Reports Component in the reStructuredText (RST) format. It addresses #199. |
There was a problem hiding this 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!
docs/components/reports.rst
Outdated
| @@ -1,4 +1,220 @@ | |||
| Reports | |||
| ####### | |||
| To add and render custom reports in Mautic, your plugin needs to listen to three events: | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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: |
There was a problem hiding this comment.
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.
docs/components/reports.rst
Outdated
| - ``ReportEvents::REPORT_ON_GENERATE`` | ||
| - ``ReportEvents::REPORT_ON_GRAPH_GENERATE`` | ||
|
|
||
| This guide walks you through defining a custom report, generating report data, and rendering graphs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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. |
There was a problem hiding this comment.
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
No description provided.