Skip to content

RFC: Adding a glossary to the GraphQL Specification #846

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

Merged
merged 1 commit into from
Apr 8, 2021

Conversation

benjie
Copy link
Member

@benjie benjie commented Apr 8, 2021

Since #777 is near to merging, it's time to extract the glossary work into a separate PR.

At this stage, the glossary is incomplete; I suggest that we merge this as an RFC as-is, iterate on it with follow-up PRs (fixing existing text and adding new definitions) and then when it's ready we can propose to the GraphQL Working Group that it gets merged into the specification.

You can read more about the intent of this PR in the included rfcs/glossary/README.md file.

Relates to GraphQL Spec Working Group action item graphql/graphql-wg#547.

@eapache
Copy link
Member

eapache commented Apr 8, 2021

I suggest that we merge this as an RFC as-is, iterate on it with follow-up PRs (fixing existing text and adding new definitions) and then when it's ready we can propose to the GraphQL Working Group that it gets merged into the specification.

👍

@leebyron
Copy link
Collaborator

leebyron commented Apr 8, 2021

Ideally these terms are defined when introduced in the context in which they're most relevant, and the glossary could then be derived from these terms. It would also be really nice to have glossary terms linked in the rendered result.

How do you feel about adding term definition and automatic glossary generation to spec-md?

@leebyron leebyron added the 📣 RFC document PR creates or changes document inside "rfc" folder label Apr 8, 2021
@leebyron leebyron merged commit dbabf1e into graphql:main Apr 8, 2021
@leebyron
Copy link
Collaborator

leebyron commented Apr 8, 2021

Merging since this is a RFC doc. I'm in strong support of having better term definition

@benjie
Copy link
Member Author

benjie commented Apr 9, 2021

I’d definitely be up for chatting with you about how the spec-md changes might work and then potentially implementing them but I don’t currently know what changes would make sense so I think it warrants discussion. Automated > manual 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📣 RFC document PR creates or changes document inside "rfc" folder
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants