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

Add Documentation for ApplyTransforms, and Add Resources to Each and PgSelect Docs #2163

Merged
merged 5 commits into from
Sep 18, 2024

Conversation

iamameme
Copy link

@iamameme iamameme commented Aug 26, 2024

Description

In my usage of Grafast at my workplace for the past few months, I've fallen in love with it. I've also obtained some learnings that I wish I had read in the docs. This is focused mainly around modifying the keys/values returned from a PgSelect. We have been working through the unique case of having to support a legacy GraphQL schema while not wanting that to affect our database design. This meant writing plans to resolve fields that required changing the returned keys and values from the DB a lot.

Hopefully, these changes might help others that run into similar use-cases.

  • Add a new docs page for the ApplyTransforms step
  • Add a new section in the each step docs with more example usage
  • Add a new section in PgSelect to link to each and applyTransforms to describe additional behavior a user may be interested in

Question that prompted this: #2161

Performance impact

  • None

Security impact

  • None

Checklist

  • None (Doc changes)

Copy link

changeset-bot bot commented Aug 26, 2024

⚠️ No Changeset found

Latest commit: b7ae095

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

…n the each step docs with more example usage. Add a new section in PgSelect to link to each and applyTransforms to describe additional behavior a user may be interested in
@iamameme iamameme force-pushed the ApplyTransforms-Docs-And-More branch from 638366e to 822b0ae Compare August 26, 2024 21:03
@benjie
Copy link
Member

benjie commented Sep 2, 2024

Thanks so much for contributing some documentation! Just a heads up that this is an unusually busy time for me: I just came back from vacation yesterday and on Saturday I'll be flying to America for GraphQLConf where I have two unfinished talks to present, so it may take me a few weeks to get around to reviewing it fully. I might do a cursory review before then if I get a chance, but it is likely to take a while to get merged. Sorry!

Copy link
Member

@benjie benjie left a comment

Choose a reason for hiding this comment

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

Thanks! This was a really great start; I've applied some editorial and clarified what the issue is and what's affected. I've also tried to avoid referencing PostGraphile-specifics in the grafast documentation, since grafast should know nothing of PostGraphile. I think this is good to go! 🙌

@benjie benjie merged commit 3f9f015 into graphile:main Sep 18, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants