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

Implement user guide for GraphQL #96

Closed
jedelman8 opened this issue Mar 5, 2021 · 4 comments · Fixed by #238
Closed

Implement user guide for GraphQL #96

jedelman8 opened this issue Mar 5, 2021 · 4 comments · Fixed by #238
Assignees
Labels
type: documentation Improvements or additions to documentation
Milestone

Comments

@jedelman8
Copy link
Contributor

jedelman8 commented Mar 5, 2021

Proposed Changes

Add a user guide for using GraphQL.

Justification

GraphQL is quite new for the network industry and having a user guide with examples will help users get started making common queries. The user guide should include examples using GraphiQL, but also how to make an HTTP POST to the /graphql endpoint using Postman and Python requests. Consider creating a "demo" repo in the Nautobot org that contains a library of GraphQL queries.

@jedelman8 jedelman8 added this to the v1.0.0 milestone Mar 5, 2021
@jtdub
Copy link
Contributor

jtdub commented Mar 5, 2021

You can assign this to me.

@glennmatthews glennmatthews added status: current type: documentation Improvements or additions to documentation labels Mar 5, 2021
@glennmatthews
Copy link
Contributor

Thanks!

@tim-fiola
Copy link
Contributor

tim-fiola commented Mar 8, 2021

Hi @jtdub @glennmatthews @jedelman8. I'm happy to take this on. I've already got a slide deck that shows step-by-step how to make the queries in Postman and native Python. I'm happy to take this off your plate since I love doing this type of stuff.

@jedelman8
Copy link
Contributor Author

@jtdub what's your timing on this? We are looking to come out of beta this month and need to see what user guides will make it for 1.0.0 and which ones we should move to 1.1.0.

@jathanism jathanism added this to To do in Release v1.0.0 Mar 24, 2021
@jedelman8 jedelman8 moved this from To do to In progress in Release v1.0.0 Apr 1, 2021
Release v1.0.0 automation moved this from In progress to Done Apr 12, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: documentation Improvements or additions to documentation
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

4 participants