Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite examples to use public APIs #8

Closed
retzkek opened this issue Apr 24, 2020 · 3 comments
Closed

Rewrite examples to use public APIs #8

retzkek opened this issue Apr 24, 2020 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@retzkek
Copy link
Contributor

retzkek commented Apr 24, 2020

Re-write all the examples to use public APIs so users have something concrete to learn with, like the Deutsche Bahn example I included in the plugin repo PR. Need to find an API that has numerical timeseries data.

@retzkek
Copy link
Contributor Author

retzkek commented Apr 25, 2020

The GitHub API is probably a good candidate, with lots of timeseries data that's relatable to by anyone who wants to use this; while it needs authentication, once a user has authenticated to Grafana through GitHub OAuth the token can be passed through. I've started a couple dashboards that anyone with a GitHub account can view, without needing anything more than the basic scopes:
https://grafana.kmr.me/github-demo/d/N2Xxd_3Zz/security-advisories?orgId=1
https://grafana.kmr.me/github-demo/d/u6O_F_qWk/repository?orgId=1

Need to support passing ISO8601 timestamps per #10 to properly scope the requests.

@retzkek
Copy link
Contributor Author

retzkek commented Apr 25, 2020

I've cleaned up the README but left the example queries, they illustrate the functionality well I think. I put the DB example in a wiki page: https://github.com/fifemon/graphql-datasource/wiki/Deutsche-Bahn-Arrivals

I'll write up the GitHub example in the wiki before closing this.

@retzkek retzkek self-assigned this Apr 25, 2020
@retzkek retzkek added the documentation Improvements or additions to documentation label May 11, 2020
@retzkek retzkek modified the milestone: v1.2.0 May 11, 2020
@retzkek
Copy link
Contributor Author

retzkek commented Mar 16, 2021

The test source server and dashboard provide consistent examples that users can learn and experiment with locally.

@retzkek retzkek closed this as completed Mar 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant