docs: For #3623 and general additions for APQ. #3711
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This makes room in the hierarchy for the work I'm about to add.
Otherwise, it was difficult to see the actual bullet-points.
…hine. We don't really demand configuration for this feature, which is enabled by default. Still, we have a lot more configuration that needs to be noted, which can't be done without sacrificing some of the structure of this page by inflating it with various implementation details that should be documented, but aren't - YET! (Stand-by for next commit!)
Since the `cache` options themselves are usable on other interfaces within Apollo Server, these interfaces likely deserve to be documented on another page eventually, but for now, this works okay and is better than them not being documented at all.
Specifically, this documents the behavior that was introduced by the below-referenced PR. Ref: #3623
This wasn't mentioned before, but seems worth documenting!
* Edits to APQ doc improvements * Update docs/source/performance/apq.md * Update docs/source/performance/apq.md Co-authored-by: Jesse Rosenberger <git@jro.cc>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This documents the
ttlsetting for APQ configuration which was introduced in #3623.That feature was already shipped but not documented at the time. In order to accommodate the additions necessary, I found it necessary to shuffle some of the content on the page around to make more specific areas within this page for configuration-related details which needed to be expanded upon (greatly). I think moving the initial block of Memcached-based configuration further down the page is warranted on its own, even more so since APQ is enabled out of the box with sensible defaults. That means it doesn't require configuration on the server (only the client) in order to get started, but this large block almost gives the impression that the user should spin up a Memcached cluster in order to reap its benefits!
I still think this page needs some additional adjustments for the CDN sections which are seemingly duplicated on the Caching page which lives alongside this "APQ" page. CDN configuration is certainly somewhat relevant to APQ, but the details seem to be more pertinent on the Caching page. Specifically, the
@cacheControlcontent seems to be repeated almost verbatim on the Caching page.This PR doesn't attempt to resolve that just yet, but focuses on delivering the documentation that makes the APQ configuration details more whole.