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

Review / Edit Technical Documents - GraphQL queries, how to download data, etc. #9

Open
liamphmurphy opened this issue Mar 12, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@liamphmurphy
Copy link
Contributor

(Original issue pulled from here: trynmaps/metrics-mvp#571)

Original Description:
We have a few guides for our GraphQL API, and I think it's technically possible for the public to pull some of our raw data. But it's not very easy for 3rd party developers to access. We should make a public site (either part of this app, or on a Wiki on this repo) that gives data/API access instructions to developers.

For Our Purposes:
Looking at the repo's primary README, this issue made me think we could edit it to do a few things:

  1. Since this repo is specific to TriMet, we could reduce clutter for onboarding by removing any references to non-Portland specific public transit systems (or perhaps documenting these elsewhere).
  2. Provide examples of the kinds of GraphQL queries made from opentransit-metrics
  3. Anything else that makes sense along these lines.
@liamphmurphy liamphmurphy added the documentation Improvements or additions to documentation label Mar 12, 2022
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