Skip to content

Commit 4d93cdf

Browse files
authored
docs: use src/README.md as source for docs (#391)
This change uses the public-facing src/readme.md as source for https://docs.victoriametrics.com/victoriametrics/victoriametrics-datasource/. The `src/README.md` is readme displayed in Grafana's plugins catalogue. It is more user friendly and focused on using the plugin. While the current root's README.md has a lot of extra info about development and advanced installation methods that might be not relevant to majority of users.
1 parent d8d46de commit 4d93cdf

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

.github/workflows/docs.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ on:
66
- main
77
paths:
88
- .github/workflows/docs.yaml
9-
- README.md
9+
- src/README.md
1010
- docs/**
1111

1212
jobs:
@@ -45,7 +45,7 @@ jobs:
4545
export TARGET="../__vm-docs/content/victoriametrics-grafana-datasource"
4646
rm -rf ${TARGET}
4747
cp -r docs ${TARGET}
48-
cp README.md ${TARGET}/
48+
cp src/README.md ${TARGET}/
4949
sed -i '/VictoriaMetrics datasource for Grafana/g' ${TARGET}/README.md
5050
sed -i 's|docs/assets/|grafana-datasource/assets/|g' ${TARGET}/README.md
5151
echo "SHORT_SHA=$(git rev-parse --short $GITHUB_SHA)" >> $GITHUB_OUTPUT

src/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# VictoriaMetrics datasource for Grafana
22

3-
The VictoriaMetrics Grafana plugin allows Grafana to query, visualize,
4-
and interact with [VictoriaMetrics](https://docs.victoriametrics.com/victoriametrics/),
3+
The [VictoriaMetrics Grafana plugin](https://grafana.com/grafana/plugins/victoriametrics-metrics-datasource/) allows
4+
Grafana to query, visualize, and interact with [VictoriaMetrics](https://docs.victoriametrics.com/victoriametrics/),
55
a high-performance metrics storage and processing system.
66

7-
<img alt="Grafana Dashboard Screenshot" src="https://raw.githubusercontent.com/VictoriaMetrics/victoriametrics-datasource/b8bf7398a9a14ba917094385d8fee08cb7e303a1/src/img/dashboard.png">
7+
<img alt="Grafana Dashboard Screenshot" width="100%" src="https://raw.githubusercontent.com/VictoriaMetrics/victoriametrics-datasource/b8bf7398a9a14ba917094385d8fee08cb7e303a1/src/img/dashboard.png">
88

99
## Capabilities
1010

@@ -21,6 +21,7 @@ Try it at [VictoriaMetrics playground](https://play-grafana.victoriametrics.com/
2121
## Installation
2222

2323
For detailed instructions on how to install the plugin on Grafana Cloud or locally, please checkout the [Plugin installation docs](https://grafana.com/docs/grafana/latest/plugins/installation/).
24+
For installation options in Docker or Kubernetes refer to [these docs](https://github.com/VictoriaMetrics/victoriametrics-datasource?tab=readme-ov-file#installation).
2425

2526
### Manual configuration via UI
2627

0 commit comments

Comments
 (0)