Skip to content

Commit

Permalink
docs: Update actions badge in README
Browse files Browse the repository at this point in the history
Signed-off-by: Mahendra Paipuri <[email protected]>
  • Loading branch information
mahendrapaipuri committed Aug 13, 2024
1 parent 7f342e0 commit 586fceb
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ pids
*.pid
*.seed
*.pid.lock
.bra.toml

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,34 @@

| | |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CI/CD | [![ci](https://github.com/mahendrapaipuri/grafana-dashboard-reporter-app/workflows/CI/badge.svg)](https://github.com/mahendrapaipuri/grafana-dashboard-reporter-app) |
| CI/CD | [![ci](https://github.com/mahendrapaipuri/grafana-dashboard-reporter-app/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/mahendrapaipuri/grafana-dashboard-reporter-app/actions/workflows/ci.yml?query=branch%3Amain) |
| Docs | [![docs](https://img.shields.io/badge/docs-passing-green?style=flat&link=https://github.com/mahendrapaipuri/grafana-dashboard-reporter-app/blob/main/src/README.md)](https://github.com/mahendrapaipuri/grafana-dashboard-reporter-app/blob/main/src/README.md) |
| Package | [![Release](https://img.shields.io/github/v/release/mahendrapaipuri/grafana-dashboard-reporter-app.svg?include_prereleases)](https://github.com/mahendrapaipuri/grafana-dashboard-reporter-app/releases/latest) |
| Meta | [![GitHub License](https://img.shields.io/github/license/mahendrapaipuri/grafana-dashboard-reporter-app)](https://gitlab.com/mahendrapaipuri/grafana-dashboard-reporter-app) [![Go Report Card](https://goreportcard.com/badge/github.com/mahendrapaipuri/grafana-dashboard-reporter-app)](https://goreportcard.com/report/github.com/mahendrapaipuri/grafana-dashboard-reporter-app) [![code style](https://img.shields.io/badge/code%20style-gofmt-blue.svg)](https://pkg.go.dev/cmd/gofmt) |

This Grafana plugin app can create PDF reports of a given dashboard using headless `chromium`
This Grafana plugin app can create PDF reports of a given dashboard using headless `chromium`
and [`grafana-image-renderer`](https://github.com/grafana/grafana-image-renderer).

![Sample report](https://github.com/mahendrapaipuri/grafana-dashboard-reporter-app/blob/main/docs/pngs/sample_report.png)

This plugin is based on the original work
[grafana-reporter](https://github.com/IzakMarais/reporter).
The core of the plugin is heavily inspired from the above stated work with some
improvements and modernization.
This plugin is based on the original work
[grafana-reporter](https://github.com/IzakMarais/reporter).
The core of the plugin is heavily inspired from the above stated work with some
improvements and modernization.

- The current plugin uses HTML templates and headless chromium to generate reports
instead of LaTeX. `grafana-image-renderer` is a prerequisite for both current and
- The current plugin uses HTML templates and headless chromium to generate reports
instead of LaTeX. `grafana-image-renderer` is a prerequisite for both current and
original plugins.

- The current plugin app exposes the reporter as a custom API end point of Grafana instance without
needing to run the [grafana-reporter](https://github.com/IzakMarais/reporter)
as a separate web service. The advantage of the plugin approach is the authenticated
- The current plugin app exposes the reporter as a custom API end point of Grafana instance without
needing to run the [grafana-reporter](https://github.com/IzakMarais/reporter)
as a separate web service. The advantage of the plugin approach is the authenticated
access to the reporter app is guaranteed by Grafana auth.

- The plugin is capable of including all the repeated rows and/or panels in the
- The plugin is capable of including all the repeated rows and/or panels in the
generated report.

- The plugin can be configured by Admins and users either from
- The plugin can be configured by Admins and users either from
[Configuration Page](./src/img/light.png) or query parameters to the report API.

## Documentation
Expand Down

0 comments on commit 586fceb

Please sign in to comment.