Page MenuHomeElementl

[docs] Dagster GraphQL Python Client [4/4]
ClosedPublic

Authored by sidkmenon on Apr 19 2021, 6:35 PM.

Details

Diff Detail

Repository
R1 dagster
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

Adding docs snippets & api docs scaffolding

Trying some stuff with dagster-graphql.rst but still not working :/

Adding API docs and rough skeleton of documentation - just needs a bit of fleshing out

Adding some more description to docs

sidkmenon edited the summary of this revision. (Show Details)

https://dagster-git-sid-python-client-elementl.vercel.app/master/_apidocs/libraries/dagster-graphql#dagster_graphql.DagsterGraphQLClient

Some return types and raises here are not formatted properly. Could you fix the docstrings?

I also think the GraphQL client deserves its own page in the docs, rather than interpolating the new information in the existing GraphQL API page - any thoughts on this @sandyryza @yuhan @sashank?

This revision now requires changes to proceed.Apr 21 2021, 6:24 PM
sidkmenon edited the summary of this revision. (Show Details)

Refactoring the dagster GraphQL client to its own docs page

Restructure docs to have same format as other pages (Relevant APIs, Overview, Examples, etc)

This revision now requires changes to proceed.Apr 22 2021, 8:20 PM

restructuring docs as per @rexledesma's advice

Forgot to run make snapshot

sandyryza added inline comments.
docs/content/_navigation.json
622

keep newline plz

docs/content/concepts/dagit/graphql-client.mdx
22

I don't feel strongly either way, but I don't think these paragraphs of justification are really necessary. Ultimately it boils down to that many people are more comfortable writing Python than GraphQL, right?

30

Maybe worth mentioning whether all the GraphQL methods are available in Python or just a subset?

sidkmenon marked 2 inline comments as done.

Responding to @sandyryza's comments

sidkmenon added inline comments.
docs/content/concepts/dagit/graphql-client.mdx
22

shortened this section a bit for clarification - the reason it was here was to emulate the docs structure for configured, etc.

This revision is now accepted and ready to land.Apr 26 2021, 7:30 PM

Reformatting reload_repository_location docs