-
Notifications
You must be signed in to change notification settings - Fork 824
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
DOC Update documentation for GraphQL v4 #10325
DOC Update documentation for GraphQL v4 #10325
Conversation
I think you may have committed the wrong file ;p |
0a37db5
to
855da13
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mentioned this on slack as well but in case you haven't seen that:
I think it would make sense to split this up.
Everything that talks about write permissions and which options are available for building the schema should probably go in the general graphql docs section somewhere (if it's not there already) - we can then just link to that. It will be relevant for anyone picking up silverstripe from scratch who wants to know how they should be building their graphql schema into the forseeable future, not just people upgrading from 3.
I think this doc should be explicitly about the fact that there is now a stable v4, what the implications for that are, and some quick info (and links to more detailed info) about upgrading from v3.
Also it'll be worth looking at https://docs.silverstripe.org/en/4/developer_guides/graphql/upgrading/ which I found when I was thinking about this - whether that should just be absorbed into these docs and that file removed, or just linked to from this doc, etc.... but we should avoid duplication as much as we can.
855da13
to
4d6910f
Compare
4d6910f
to
9090339
Compare
eb5aff9
to
3c7381a
Compare
There is an inconsistency in performance in the docs that I'm not sure how to handle, having done no benchmarking myself. In the original documentation written by UncleCheese (in
In the new docs written by @maxime-rainville which I've added to
This is a massive discrepancy... which is accurate? Are they both somehow accurate? Is it okay to leave the docs saying what seem to be two conflicting statements, and if not, how should this be handled? |
ad91379
to
7f3b9f4
Compare
The existing upgrading docs are for upgrading to v4, whereas the new docs are more about how to handle the new .graphql-generated directory.
7f3b9f4
to
1d02b91
Compare
1d02b91
to
22a08b9
Compare
docs/en/02_Developer_Guides/19_GraphQL/01_getting_started/01_activating_the_server.md
Show resolved
Hide resolved
docs/en/02_Developer_Guides/19_GraphQL/01_getting_started/02_configuring_your_schema.md
Show resolved
Hide resolved
docs/en/02_Developer_Guides/19_GraphQL/01_getting_started/02_configuring_your_schema.md
Outdated
Show resolved
Hide resolved
docs/en/02_Developer_Guides/19_GraphQL/01_getting_started/05_deploying_the_schema.md
Show resolved
Hide resolved
docs/en/02_Developer_Guides/19_GraphQL/01_getting_started/05_deploying_the_schema.md
Show resolved
Hide resolved
docs/en/02_Developer_Guides/19_GraphQL/01_getting_started/05_deploying_the_schema.md
Outdated
Show resolved
Hide resolved
docs/en/02_Developer_Guides/19_GraphQL/01_getting_started/05_deploying_the_schema.md
Outdated
Show resolved
Hide resolved
docs/en/02_Developer_Guides/19_GraphQL/02_working_with_dataobjects/04_inheritance.md
Show resolved
Hide resolved
docs/en/02_Developer_Guides/19_GraphQL/03_working_with_generic_types/03_resolver_discovery.md
Outdated
Show resolved
Hide resolved
docs/en/02_Developer_Guides/19_GraphQL/04_security_and_best_practices/02_cors.md
Show resolved
Hide resolved
22a08b9
to
85fe016
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for quick turn around
Only thing I'm concerned with here is the ordering of the schema generation options.
docs/en/02_Developer_Guides/19_GraphQL/01_getting_started/05_deploying_the_schema.md
Show resolved
Hide resolved
85fe016
to
ac1bb24
Compare
This updates some of the existing GraphQL documentation to match up with the new functionality, be a bit clearer, and some formatting/grammar updates.
The new section in the 4.11.0 changelog is mostly copied from the beta/RC changelog but includes a new "What do I need to know to get started?" section linking to relevant additional information (namely how to upgrade custom schemas, and how to build schemas).
Related PR
Parent issue