Skip to content

Commit

Permalink
docs: Add a note on deprecated dataPath config var
Browse files Browse the repository at this point in the history
Signed-off-by: Mahendra Paipuri <mahendra.paipuri@gmail.com>
  • Loading branch information
mahendrapaipuri committed May 20, 2024
1 parent febce73 commit 7976ac0
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
13 changes: 10 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,27 @@
"name": "mahendrapaipuri-dashboardreporter-app",
"version": "1.3.0",
"description": "A Grafana plugin app that generates PDF reports from Grafana dashboards",
"config": {
"plainUrl": "http://admin:admin@localhost:3080/api/plugins/mahendrapaipuri-dashboardreporter-app/resources/report?dashUid=fdlwjnyim1la8f&layout=simple&orientation=portrait&dashboardMode=default&var-testvar0=All&var-testvar1=foo&var-testvar2=1",
"tlsUrl": "https://admin:admin@localhost:3443/api/plugins/mahendrapaipuri-dashboardreporter-app/resources/report?dashUid=fdlwjnyim1la8f&layout=grid&orientation=landscape&dashboardMode=full&from=now-5m&to=now&var-testvar0=All&var-testvar1=foo&var-testvar2=1"
},
"scripts": {
"build": "webpack -c ./.config/webpack/webpack.config.ts --env production",
"build:plugin": "yarn install --pure-lockfile && yarn build && mage -v",
"package": "yarn build:plugin && zip -r mahendrapaipuri-dashboardreporter-app.zip",
"dev": "webpack -w -c ./.config/webpack/webpack.config.ts --env development",
"e2e:update": "npm exec cypress install && npm exec grafana-e2e run --update-screenshots",
"e2e:update": "playwright test --update-screenshots",
"e2e": "yarn playwright install && playwright test",
"e2e:server:up": "docker-compose -f .ci/docker-compose.yaml up --build -d",
"e2e:server:down": "docker-compose -f .ci/docker-compose.yaml down",
"e2e:server:podman:up": "podman-compose -f .ci/docker-compose.yaml up --build -d",
"e2e:server:podman:down": "podman-compose -f .ci/docker-compose.yaml down",
"e2e:report:plain": "curl -f -o default.pdf 'http://admin:admin@localhost:3080/api/plugins/mahendrapaipuri-dashboardreporter-app/resources/report?dashUid=fdlwjnyim1la8f&layout=simple&orientation=portrait&dashboardMode=default&var-testvar0=All&var-testvar1=foo&var-testvar2=1'",
"e2e:report:tls": "curl -k -f -o alternative.pdf 'https://admin:admin@localhost:3443/api/plugins/mahendrapaipuri-dashboardreporter-app/resources/report?dashUid=fdlwjnyim1la8f&layout=grid&orientation=landscape&dashboardMode=full&from=now-5m&to=now&var-testvar0=All&var-testvar1=foo&var-testvar2=1'",
"e2e:report:plain": "curl -f -o default.pdf $npm_package_config_plainUrl",
"e2e:report:tls": "curl -k -f -o alternative.pdf $npm_package_config_tlsUrl",
"e2e:report": "yarn e2e:report:plain && yarn e2e:report:tls",
"e2e:report:update:plain": "curl -f -o .ci/reports/default.pdf $npm_package_config_plainUrl",
"e2e:report:update:tls": "curl -k -f -o .ci/reports/alternative.pdf $npm_package_config_tlsUrl",
"e2e:report:update": "yarn e2e:report:update:plain && yarn e2e:report:update:tls",
"lint:fix": "npm run lint -- --fix",
"lint": "eslint --cache --ignore-path ./.gitignore --ext .js,.jsx,.ts,.tsx .",
"server": "docker-compose up --build",
Expand Down
5 changes: 5 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,11 @@ The following configuration parameters are directly tied to Grafana instance
and cannot be changed without restarting Grafana instance. Hence, these config parameters
can only be set using provisioning method and **it is not possible to configure them in Grafana UI**.

> [!NOTE]
> Starting from `v1.4.0`, config parameter `dataPath` is not needed anymore as the plugin
will get the Grafana's data path based on its own executable path. If the existing provisioned
configs have this parameter set, it will be ignored while loading the plugin's configuration.

### Report parameters

All the configuration parameters can only be modified by `Admin` role.
Expand Down

0 comments on commit 7976ac0

Please sign in to comment.