Skip to content

Commit 20a9dca

Browse files
authored
docs: use src/README.md as source for docs (#398)
This change uses the public-facing src/readme.md as source for https://docs.victoriametrics.com/victorialogs/victorialogs-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 d56e097 commit 20a9dca

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

.github/workflows/docs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ jobs:
4545
export TARGET="../__vm-docs/content/victorialogs-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 '/VictoriaLogs 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: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# VictoriaLogs datasource for Grafana
22

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

77
<img alt="Grafana Dashboard Screenshot" src="https://github.com/VictoriaMetrics/victorialogs-datasource/blob/main/src/img/dashboard.png?raw=true">
@@ -19,6 +19,7 @@ Try it at [VictoriaMetrics playground](https://play-grafana.victoriametrics.com/
1919
## Installation
2020

2121
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/).
22+
For installation options in Docker or Kubernetes refer to [these docs](https://github.com/VictoriaMetrics/victorialogs-datasource?tab=readme-ov-file#installation).
2223

2324
### Manual configuration via UI
2425

0 commit comments

Comments
 (0)