Page MenuHomeElementl
Differential D7504

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

Authored by • sidkmenon on Apr 19 2021, 6:35 PM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, May 12, 12:59 PM
Unknown Object (File)
Apr 7 2023, 1:11 PM
Unknown Object (File)
Apr 1 2023, 11:39 AM
Unknown Object (File)
Mar 18 2023, 7:36 PM
Unknown Object (File)
Mar 11 2023, 12:36 AM
Unknown Object (File)
Feb 28 2023, 11:51 AM
Unknown Object (File)
Feb 27 2023, 2:09 PM
Unknown Object (File)
Feb 14 2023, 11:00 AM
View All 74 Files
Subscribers
None

Details

Reviewers
• sashank
• yuhan
• sandyryza
• rexledesma
Commits
R1:e929746efd1c: [docs] Dagster GraphQL Python Client [4/4]
Summary

Adding docs for the Dagster GraphQL client

Depends on D7409, D7421, D7424

Vercel docs draft is located here: https://dagster-git-sid-python-client-elementl.vercel.app/master/concepts/dagit/graphql-client

Test Plan

bk

Diff Detail

Repository
R1 dagster
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

• sidkmenon created this revision.Apr 19 2021, 6:35 PM
• sidkmenon held this revision as a draft.
• sidkmenon edited the summary of this revision. (Show Details)Apr 19 2021, 6:36 PM
• sidkmenon added parent revisions: D7424: [dagster-graphql] Dagster GraphQL Python Client [3/4], D7421: [dagster-graphql] Dagster GraphQL Python Client [2/4], D7409: [RFC] [dagster-graphql] Python Client Implementation [1/4].
Harbormaster failed remote builds in B29077: Diff 35687!Apr 19 2021, 6:54 PM
• sidkmenon updated this revision to Diff 35830.Apr 20 2021, 4:00 PM

Adding docs snippets & api docs scaffolding

• sidkmenon added reviewers: • sashank, • yuhan.Apr 20 2021, 4:01 PM
Harbormaster failed remote builds in B29201: Diff 35830!Apr 20 2021, 4:18 PM
• sidkmenon updated this revision to Diff 35856.Apr 20 2021, 5:57 PM

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

Harbormaster failed remote builds in B29219: Diff 35856!Apr 20 2021, 6:15 PM
• sidkmenon updated this revision to Diff 35872.Apr 20 2021, 7:15 PM

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

• sidkmenon added a reviewer: • sandyryza.Apr 20 2021, 7:18 PM
Harbormaster failed remote builds in B29231: Diff 35872!Apr 20 2021, 7:35 PM
• sidkmenon updated this revision to Diff 35925.Apr 21 2021, 3:36 PM

Adding some more description to docs

• sidkmenon edited the summary of this revision. (Show Details)Apr 21 2021, 3:42 PM
• sidkmenon added a reviewer: • rexledesma.
Harbormaster completed remote builds in B29273: Diff 35925.Apr 21 2021, 3:57 PM
• sidkmenon published this revision for review.Apr 21 2021, 4:24 PM
• sidkmenon edited the summary of this revision. (Show Details)
• rexledesma requested changes to this revision.Apr 21 2021, 6:24 PM

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 updated this revision to Diff 36005.Apr 22 2021, 6:07 PM

Fixing API docs issues

Harbormaster completed remote builds in B29331: Diff 36005.Apr 22 2021, 6:27 PM
• sidkmenon edited the summary of this revision. (Show Details)Apr 22 2021, 6:44 PM
• sidkmenon updated this revision to Diff 36016.Apr 22 2021, 6:47 PM
• sidkmenon edited the summary of this revision. (Show Details)

Refactoring the dagster GraphQL client to its own docs page

• sidkmenon edited the summary of this revision. (Show Details)Apr 22 2021, 6:55 PM
Harbormaster completed remote builds in B29340: Diff 36016.Apr 22 2021, 7:05 PM
• rexledesma requested changes to this revision.Apr 22 2021, 8:20 PM

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
• sidkmenon updated this revision to Diff 36087.Apr 23 2021, 5:02 PM

restructuring docs as per @rexledesma's advice

Harbormaster failed remote builds in B29392: Diff 36087!Apr 23 2021, 5:24 PM
• sidkmenon updated this revision to Diff 36089.Apr 23 2021, 5:29 PM

Forgot to run make snapshot

Harbormaster completed remote builds in B29394: Diff 36089.Apr 23 2021, 5:47 PM
• sidkmenon updated this revision to Diff 36112.Apr 23 2021, 8:31 PM

Responding to @rexledesma's comments

Harbormaster completed remote builds in B29413: Diff 36112.Apr 23 2021, 8:52 PM
• sandyryza accepted this revision.Apr 26 2021, 4:29 PM
• 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 updated this revision to Diff 36184.Apr 26 2021, 5:27 PM
• sidkmenon marked 2 inline comments as done.

Responding to @sandyryza's comments

• sidkmenon marked an inline comment as done.Apr 26 2021, 5:28 PM
• 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.

Harbormaster completed remote builds in B29478: Diff 36184.Apr 26 2021, 5:48 PM
• rexledesma accepted this revision.Apr 26 2021, 7:30 PM

The API docs for https://dagster-git-sid-python-client-elementl.vercel.app/master/_apidocs/libraries/dagster-graphql#dagster_graphql.DagsterGraphQLClient.reload_repository_location look like they need formatting, but everything else looks great

This revision is now accepted and ready to land.Apr 26 2021, 7:30 PM
• sidkmenon updated this revision to Diff 36210.Apr 26 2021, 8:01 PM

Reformatting reload_repository_location docs

Harbormaster completed remote builds in B29496: Diff 36210.Apr 26 2021, 8:20 PM
Closed by commit R1:e929746efd1c: [docs] Dagster GraphQL Python Client [4/4] (authored by Sidharth Menon <menon.sid.k@gmail.com>). · Explain WhyApr 26 2021, 8:22 PM
This revision was automatically updated to reflect the committed changes.
Sidharth Menon <menon.sid.k@gmail.com> added a commit: R1:e929746efd1c: [docs] Dagster GraphQL Python Client [4/4].

Revision Contents
Changeset List

PathSize
docs/
content/
2 lines
4 lines
api/
concepts/
dagit/
153 lines
4 lines
next/
components/
mdx/
8 lines
sphinx/
3 lines
sections/
api/
apidocs/
libraries/
18 lines
examples/
docs_snippets/
docs_snippets/
concepts/
dagit/
graphql/
108 lines
python_modules/
dagster-graphql/
dagster_graphql/
client/
7 lines
8 lines

Diff 36213

View Options

docs/content/_apidocs.mdx

Loading...
View Options

docs/content/_navigation.json

Loading...
View Options

docs/content/api/modules.json

Loading...
View Options

docs/content/api/searchindex.json

Loading...
View Options

docs/content/api/sections.json

Loading...
View Options

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

Loading...
View Options

docs/content/concepts/dagit/graphql.mdx

Loading...
View Options

docs/next/components/mdx/MDXComponents.tsx

Loading...
View Options

docs/sphinx/index.rst

Loading...
View Options

docs/sphinx/sections/api/apidocs/libraries/dagster-graphql.rst

Loading...
View Options

examples/docs_snippets/docs_snippets/concepts/dagit/graphql/client_example.py

Loading...
View Options

python_modules/dagster-graphql/dagster_graphql/client/__init__.py

Loading...
View Options

python_modules/dagster-graphql/dagster_graphql/client/client.py

Loading...