mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

feat: markdown support in report's description

Browse Source 
* markdown support in report list and report result pages
* Add notes in the documentation regarding markdown
This commit is contained in:
maxime-gerges-external
2021-06-03 14:48:18 +02:00
parent 46ecb0ac03
commit e61b2b1fc5
3 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/additional-features/reports.md
View File

@@ -85,6 +85,9 @@ As you can see, reports are completely customizable. Validation logic can be as
!!! warning
Reports should never alter data: If you find yourself using the `create()`, `save()`, `update()`, or `delete()` methods on objects within reports, stop and re-evaluate what you're trying to accomplish. Note that there are no safeguards against the accidental alteration or destruction of data.
!!! note
The `description`attribute support markdown syntax. You can use markdown to print fency description in the report list page.
The following methods are available to log results within a report:
* log(message)
@@ -95,6 +98,9 @@ The following methods are available to log results within a report:
The recording of one or more failure messages will automatically flag a report as failed. It is advised to log a success for each object that is evaluated so that the results will reflect how many objects are being reported on. (The inclusion of a log message is optional for successes.) Messages recorded with `log()` will appear in a report's results but are not associated with a particular object or status.
!!! note
Every `log_`methods support markdown syntax. Thus you can use markdown in the message and it will be printed as such in the report result.
To perform additional tasks, such as sending an email or calling a webhook, after a report has been run, extend the `post_run()` method. The status of the report is available as `self.failed` and the results object is `self.result`.
Once you have created a report, it will appear in the reports list. Initially, reports will have no results associated with them. To generate results, run the report.