Skip to content

Docs improvements#624

Merged
phalt merged 2 commits intomasterfrom
docs-improvements
May 7, 2019
Merged

Docs improvements#624
phalt merged 2 commits intomasterfrom
docs-improvements

Conversation

@phalt
Copy link
Copy Markdown
Contributor

@phalt phalt commented Apr 30, 2019

Rewrite of the documentation, splitting up the docs into the following structure:

  • installation - new
  • tutorial-plain - currently untouched
  • tutorial-relay - currently untouched
  • schema - new
  • queries - new
  • mutations - new
  • filtering
  • authorization
  • debug
  • introspection
  • testing

Django REST Framework and Django forms will move under "mutations".

Relay will move under queries and mutations (where it makes sense).

I am NOT rewriting the tutorials yet as they're huge!

TODO:

  • Document why relay and mutations is important

@coveralls
Copy link
Copy Markdown

Coverage Status

Coverage remained the same at 94.216% when pulling 0f7844b on docs-improvements into 2016011 on master.

2 similar comments
@coveralls
Copy link
Copy Markdown

Coverage Status

Coverage remained the same at 94.216% when pulling 0f7844b on docs-improvements into 2016011 on master.

@coveralls
Copy link
Copy Markdown

Coverage Status

Coverage remained the same at 94.216% when pulling 0f7844b on docs-improvements into 2016011 on master.

@coveralls
Copy link
Copy Markdown

coveralls commented Apr 30, 2019

Coverage Status

Coverage remained the same at 93.934% when pulling 15b5e6a on docs-improvements into 6f03597 on master.

Comment thread docs/installation.rst Outdated
Comment thread docs/installation.rst Outdated
Comment thread docs/installation.rst Outdated
Comment thread docs/tutorial-plain.rst Outdated
Comment thread docs/tutorial-plain.rst Outdated
Comment thread docs/installation.rst
Comment thread docs/schema.rst Outdated
Comment thread docs/schema.rst Outdated
Comment thread docs/schema.rst Outdated
Comment thread docs/queries.rst Outdated
Comment thread docs/queries.rst Outdated
Comment thread docs/mutations.rst Outdated
@dopeboy
Copy link
Copy Markdown

dopeboy commented Apr 30, 2019

This is a huge leap forward @phalt, thank you. Most of my feedback above is stylistic and grammatical in nature. The broad strokes of your work are spot on. My only high level concerns:

  • There's some duplication of content between the installation & basic tutorial guides. I'm worried our reader might get confused.
  • To me, there's two logical groupings of the content that I don't think is obvious. The first three are squarely "get up and going" sort of guides whereas everything that proceeds that is a "let's dig in deeper" sort of flavor. I'm wondering whether it makes sense to distinguish tha.t
  • We're treating Relay as an afterthought in a lot of these guides. I'm wondering whether it makes sense to factor it out into its own section?

Comment thread docs/mutations.rst
@phalt
Copy link
Copy Markdown
Contributor Author

phalt commented May 2, 2019

Thanks for the feedback @dopeboy and @subwindow

Yes, my grammar isn't great so that feedback is useful for me!

Regarding your points:

There's some duplication of content between the installation & basic tutorial guides. I'm worried our reader might get confused.

I've not yet updated the basic tutorial guide but I want to reduce some of the duplication. I'm also aware the current docs are hard to read because it's all spread out. Does it make sense to duplicate a few things just to make it easier to read through a page in one go? Suggestions welcome.

To me, there's two logical groupings of the content that I don't think is obvious. The first three are squarely "get up and going" sort of guides whereas everything that proceeds that is a "let's dig in deeper" sort of flavor. I'm wondering whether it makes sense to distinguish that

Yeah I wanted to make this clearer and I think it'll be better as I finish up. I based the docs around how I see the project from the point of view of a user - what does a user want to do versus what does this project provide. For example - currently Django users come to these docs, see a bare minimum of content, and don't know they have to visit the core graphene docs to find what they need.

We're treating Relay as an afterthought in a lot of these guides. I'm wondering whether it makes sense to factor it out into its own section?

Again, I don't really see Relay as a separate topic but rather an extension on top of Queries / Mutations. This is my opinion, and I'm happy to change it if the consensus is that it should be separate. But I feel like it flows better to talk about Relay for Queries when talking about Queries, etc.

@phalt phalt force-pushed the docs-improvements branch from 7fa5354 to 9eabb7a Compare May 3, 2019 10:48
Comment thread docs/mutations.rst
id = graphene.ID()

# The class attributes define the response of the mutation
question = graphene.Field(QuestionType)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can also do Output = QuestionType and then just return the question instance in the mutate method

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well today I learned! See, this is why we need the better docs 😆 I'll add this

@mvanlonden
Copy link
Copy Markdown
Member

This is a vast improvement on what we currently have. Thank you 🙏

Copy link
Copy Markdown
Collaborator

@zbyte64 zbyte64 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for improving the documentation

@phalt phalt force-pushed the docs-improvements branch from 82601ab to 31468f5 Compare May 7, 2019 18:23
@phalt phalt merged commit c0fbed2 into master May 7, 2019
@phalt phalt deleted the docs-improvements branch May 7, 2019 18:35
@clarkmoody
Copy link
Copy Markdown

Just wanted to pop in and say thanks for updating the docs 🎉

@phalt
Copy link
Copy Markdown
Contributor Author

phalt commented May 8, 2019

@clarkmoody no problems, wait until you see what I do next!

@jkimbo
Copy link
Copy Markdown
Member

jkimbo commented Jun 4, 2019

@phalt great job! So much better!

@phalt
Copy link
Copy Markdown
Contributor Author

phalt commented Jun 5, 2019

@jkimbo thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants