Skip to content

Commit

Permalink
Merge pull request #262 from dinger1986/main
Browse files Browse the repository at this point in the history
added contributing reporting templates
  • Loading branch information
silversword411 authored May 7, 2024
2 parents d5d4d22 + c59fb5b commit 5c95674
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/contributing_reporting_templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Reporting Templates

## Template Names

Templates should be named in such a way it is clear and concise for others to know what the template does.

## Prerequisites
Before you begin, ensure you are:

- Familiar with the report data available in Tactical RMM. Read more about reporting [here](https://docs.tacticalrmm.com/ee/reporting/reporting_overview/).
- Up and running with Tactical RMM, for testing purposes (you can safely use your live environment).
- Creating a new/unique Report Template, existing templates are available [here](https://github.com/amidaware/reporting-templates).

## Once your template is ready:

1. Fork the Tactical RMM template repository on GitHub.
2. Export your template from Tactical RMM Reporting manager by right clicking and clicking export.
3. Create a new template in the templates folder and copy and paste in code or upload exported template.
4. Create a pull request with a brief description of your template and why it's useful.
5. The Tactical RMM team will review your submission and test it, provide tests pass etc your PR will be accepted, if theres issues feedback will be provided in the comments section of the PR.

Thank you for contributing to Tactical RMM and helping enhance the reporting capabilities for all users!
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ nav:
- Contributing:
- "Contributing to Docs": contributing.md
- "Contributing to Community Scripts": contributing_community_scripts.md
- "Contributing to Reporting Templates": contributing_reporting_templates.md
- "Contributing using a browser": contributing_using_browser.md
- "Contributing using VS Code": contributing_using_vscode.md
- "Contributing using Docker": contributing_using_docker.md
Expand Down

0 comments on commit 5c95674

Please sign in to comment.