Adds comprehensive context key reference to docs#8420
Conversation
This comment has been minimized.
This comment has been minimized.
✅ Docs preview readyThe preview is ready to be viewed. View the preview File Changes 0 new, 2 changed, 0 removedBuild ID: a5140f61af01d6bb372b3b18 URL: https://www.apollographql.com/docs/deploy-preview/a5140f61af01d6bb372b3b18 |
| @@ -0,0 +1,35 @@ | |||
| ### Adds comprehensive context key reference to docs ([PR #8420](https://github.com/apollographql/router/pull/8420)) | |||
There was a problem hiding this comment.
I think something went wrong in the changeset here? I'm seeing a checklist that should only be in the PR description.
We can also remove this changeset because docs-only PRs typically don't need one.
There was a problem hiding this comment.
Generally speaking, it's true that docs stuff doesn't need them, but I like to highlight really valuable documentation additions in our changesets, and I feel like this is one of them.
The changesets tooling defaults to the PR description that appears above the <!-- start metadata --> line in the PR template, but since this PR had no description, it just defaulted to the entire PR contents.
@faisalwaseem If you don't have time to fix the changeset, I can take a shot at it. Alternatively, agree to just delete it.
There was a problem hiding this comment.
I am ok with removing the changeset since the change is so minor
There was a problem hiding this comment.
FYI I did take a crack and fixing the changeset file lets see if that works
There was a problem hiding this comment.
Ahh thanks for clarifying Jesse! and looks like the changeset looks better now 🙌🏽 I'll go ahead and review the meat of the PR 👀
This change documents all the context keys router supports as of submitting this PR.
mabuyo
left a comment
There was a problem hiding this comment.
@faisalwaseem I made a few edits directly (reasoning in commit messages / comments). Just need confirmation for a couple property names. Thanks for improving these docs!
faisalwaseem
left a comment
There was a problem hiding this comment.
I am good with the changes proposed. Thank you for the reviews
faisalwaseem
left a comment
There was a problem hiding this comment.
Aligned with the changes
This change documents all the context keys router supports as of submitting this PR.
Checklist
Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.
Exceptions
This is only a change in documentation
Note any exceptions here
Notes
Footnotes
It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this. ↩
Configuration is an important part of many changes. Where applicable please try to document configuration examples. ↩
A lot of (if not most) features benefit from built-in observability and
debug-level logs. Please read this guidance on metrics best-practices. ↩Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions. ↩