Skip to content

[DXM-100] Add Redis TLS config shared component#9172

Draft
bignimbus wants to merge 2 commits intodevfrom
fix/DXM-100-redis-tls-shared-component
Draft

[DXM-100] Add Redis TLS config shared component#9172
bignimbus wants to merge 2 commits intodevfrom
fix/DXM-100-redis-tls-shared-component

Conversation

@bignimbus
Copy link
Copy Markdown

@bignimbus bignimbus commented Apr 10, 2026

Summary

Resolves DXM-100.

The docs mention that any Redis connection supports a TLS config, but this information only lived in a single spot (TLS configuration overview) that users were unlikely to discover when reading a feature page directly (APQ, Entity Cache, response caching, etc.).

This PR:

  • Updates the existing shared component docs/shared/redis-tls.mdx with generic, feature-agnostic content and a clean YAML example showing just the redis.tls block structure
  • Imports and renders that shared component on every feature page that exposes a Redis configuration section:
    • docs/source/routing/operations/apq.mdx (APQ distributed caching)
    • docs/source/routing/query-planning/caching.mdx (query plan distributed caching)
    • docs/source/routing/performance/caching/response-caching/customization.mdx (response cache advanced Redis config)
    • docs/source/routing/security/tls.mdx (TLS overview — Redis section)
  • Removes duplicate inline TLS content from each of those pages (55 lines of duplication eliminated)

Acceptance criteria

  • Redis TLS config info is now visible contextually on each feature page that configures Redis
  • A single shared component (docs/shared/redis-tls.mdx) is the single source of truth for the Redis TLS blurb
  • The shared component links back to the full TLS configuration page for comprehensive details

Jeff's direction

You'll need to work from the repo apollographql/router. From the project root, look for docs/source/routing/configuration/overview.mdx. Search for other Redis TLS config references per the ticket, you'll need to look over everything in the /docs/ directory (including nested directories) to find all the areas where we could include this shared context.

Ticket: https://apollographql.atlassian.net/browse/DXM-100

@apollo-librarian
Copy link
Copy Markdown
Contributor

apollo-librarian bot commented Apr 10, 2026

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 4 changed, 0 removed
* graphos/routing/(latest)/operations/apq.mdx
* graphos/routing/(latest)/performance/caching/response-caching/customization.mdx
* graphos/routing/(latest)/query-planning/caching.mdx
* graphos/routing/(latest)/security/tls.mdx

Build ID: 365e3b078eaee2b230258aa1
Build Logs: View logs

URL: https://www.apollographql.com/docs/deploy-preview/365e3b078eaee2b230258aa1


⚠️ AI Style Review — 6 Issues Found

Summary

The documentation has been updated to align with the style guide across several sections. In structural-elements, changes include specifying programming languages for syntax highlighting, closing code blocks, and ensuring two newlines are used within admonition components for correct formatting. Text-formatting was improved by replacing vague links with descriptive noun phrases. In framing and voice, instructions were updated to use the imperative mood and an authoritative, helpful tone was adopted by removing permissive phrasing like 'you can' to ensure actionable content.

Duration: 2965ms
Review Log: View detailed log

This review is AI-generated. Please use common sense when accepting these suggestions, as they may not always be accurate or appropriate for your specific context.

@github-actions
Copy link
Copy Markdown
Contributor

@bignimbus, please consider creating a changeset entry in /.changesets/. These instructions describe the process and tooling.

bignimbus and others added 2 commits April 10, 2026 15:53
Refactor the Redis TLS configuration documentation into a reusable shared
MDX component (docs/shared/redis-tls.mdx) and include it on every feature
page that exposes Redis configuration—APQ, query plan caching, response
cache customization, and the TLS overview—so users discover the TLS option
contextually rather than only on the overview page.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Allows for the shared component to accept arbitrary MDX to account for
differences in the nesting of redis configs
@bignimbus bignimbus force-pushed the fix/DXM-100-redis-tls-shared-component branch from 527537a to b43c4b3 Compare April 10, 2026 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant