Skip to content

Commit

Permalink
Updated proper README
Browse files Browse the repository at this point in the history
  • Loading branch information
ggracechoi committed Jul 19, 2023
1 parent 2bc3048 commit 130e98d
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/is-compatible.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ jobs:
- name: Build plugin
run: npm run build
- name: Compatibility check
run: npx @grafana/levitate@latest is-compatible --path src/module.ts --target @grafana/data,@grafana/ui,@grafana/runtime
run: npx @grafana/levitate@latest is-compatible --path src/module.ts --target @grafana/data,@grafana/ui,@grafana/runtime
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
18
18
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@
"rxjs": "7.8.0",
"tslib": "2.5.3"
}
}
}
2 changes: 1 addition & 1 deletion src/datasources/data-frame/DataFrameDataSource.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -285,4 +285,4 @@ const defaultQuery: DataQueryRequest<DataFrameQuery> = {
app: 'explore',
startTime: 0,
targets: [],
};
};
13 changes: 4 additions & 9 deletions src/datasources/data-frame/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
# Systemlink Data Frame data source

This plugin will have three main workflows:

- Populating a
[query variable](https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#add-a-query-variable)
with a list of user-accessible systems

- Visualizing system connection status counts on a dashboard

- Visualizing system metadata on a dashboard
<!--
TODO: Write a short description of your plugin and document any extra
configuration that is required for development.
-->
10 changes: 6 additions & 4 deletions src/datasources/system/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Systemlink System data source

<!--
TODO: Write a short description of your plugin and document any extra
configuration that is required for development.
-->
This is a plugin for the Systems Management service. It allows you to:
- Populate a
[query variable](https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#add-a-query-variable)
with a list of systems connected to the server
- Visualize system connection status counts on a dashboard
- Visualize system metadata on a dashboard

0 comments on commit 130e98d

Please sign in to comment.