docs: add official/community support sections to self-hosting infra pages#3299
docs: add official/community support sections to self-hosting infra pages#3299Steffen911 wants to merge 1 commit into
Conversation
…ructure pages Add an "Official and Community Support" section at the top of the ClickHouse, Redis/Valkey, blob storage, and Postgres infrastructure pages to distinguish officially supported options from community-supported ones. Tier definitions and the issue/PR call-to-action live in a shared components-mdx snippet. Details: - Blob storage: S3, GCS, Azure Blob Storage, MinIO/AIStor, and R2 are official; OCI, Tigris, and other S3-compatible providers are community. Group community providers at the end of the page. - ClickHouse: ClickHouse Cloud, BYOC, and the official Kubernetes operator are official (new short section for the operator); Bitnami Helm chart and single-container Docker are community. - Redis/Valkey: Redis >= 7 and Valkey >= 8 (self-hosted or managed) are official; other Redis-compatible stores are community. Update the "Valkey vs Redis" section accordingly and fix a wrong Langfuse K8s link plus a Clickhouse/Valkey copy-paste error. - Postgres: PostgreSQL >= 12 and Aurora PostgreSQL are official; other Postgres-compatible databases are community. - Add explicit [#anchor] ids to all headings referenced by the new tables. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
@claude review |
There was a problem hiding this comment.
Looks good — a straightforward docs-only change adding official/community support tables to four self-hosting infra pages, following an established pattern with a shared components-mdx snippet. The one inline nit (missing single-shard callout in the new ClickHouse Operator section) is a minor completeness suggestion, not a factual error, so it doesn't block approval.
Extended reasoning...
Overview
This PR adds an "Official and Community Support" section to four self-hosting infrastructure docs pages (blobstorage, cache/Redis, clickhouse, postgres), backed by a new shared snippet component (components-mdx/self-host-support-levels.mdx). It reorders a couple of sections (moving community-tier providers like Tigris to the end), adds explicit [#anchor] ids to headings referenced by the new tables, adds a new short 'ClickHouse Kubernetes Operator' subsection, and fixes two pre-existing copy-paste errors (a wrong Langfuse K8s Helm link, and a ClickHouse/Valkey wording mixup in cache.mdx).
Security risks
None. This is pure MDX documentation content with no code, no secrets, and no runtime behavior change — only prose, tables, and anchor links.
Level of scrutiny
Low-to-moderate is appropriate: it's a docs-only, non-critical-path PR (labeled docs, size:L due to line churn from reordering, not complexity). I verified there's exactly one H1 per changed file, headings stay in order without skipped levels, and the new table anchors (#amazon-s3, #minio, #cloudflare-r2, #oci-object-storage, #tigris, #other-providers, #clickhouse-kubernetes-operator, #clickhouse-on-kubernetes-helm, #docker, #cloudbyoc, #user-permissions, #timezones, #valkey-vs-redis) all resolve to headings that carry matching explicit [#id] markers, satisfying the anchor-linking convention in this repo's guidelines.
Other factors
The one inline finding (ClickHouse Kubernetes Operator section omitting the single-shard requirement that the sibling Helm section states explicitly) is flagged as a Nit — it's a documentation completeness gap, not incorrect or misleading information as written, and is easy for the author to address with a one-line follow-up. The other four candidate issues raised by the bug-hunting system were investigated and ruled out as not real bugs. No prior claude[bot] review exists on this PR (this is the first pass), so there's no unaddressed feedback thread to consider.
Add an "Official and Community Support" section at the top of the ClickHouse, Redis/Valkey, blob storage, and Postgres infrastructure pages to distinguish officially supported options from community-supported ones. Tier definitions and the issue/PR call-to-action live in a shared components-mdx snippet.
Details:
Greptile Summary
This PR adds an "Official and Community Support" section at the top of the four self-hosting infrastructure pages (blob storage, cache, ClickHouse, Postgres), backed by a new shared
SelfHostSupportLevelsMDX snippet. It also introduces a new ClickHouse Kubernetes Operator subsection, moves Tigris to the community group in the blob storage page, and fixes two pre-existing bugs incache.mdx(wrong Langfuse K8s link and a Clickhouse/Valkey copy-paste error in a comment).components-mdx/self-host-support-levels.mdxsnippet defines the Official/Community tier and a GitHub issue/PR call-to-action, imported and rendered on all four infrastructure pages.[#anchor]IDs; the Valkey vs Redis section wording is updated to reflect official support status.cache.mdx("At least version 7 is required") was not updated alongside the new table that states Valkey requires>= 8, leaving a minor contradiction for readers who only skim the introduction.Confidence Score: 4/5
Documentation-only change; no runtime code is affected. Safe to merge.
The content additions are accurate and the anchor/link wiring looks correct throughout. The one substantive inconsistency is in cache.mdx: the existing intro sentence 'At least version 7 is required' now contradicts the new table's Valkey >= 8 requirement, which could mislead self-hosters who only read the introductory paragraph. The import placement issue appears in all four content files but is a style concern with no user-visible impact.
content/self-hosting/deployment/infrastructure/cache.mdx — the intro version-requirement sentence should be updated to match the new Valkey >= 8 entry in the support table.
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[User picks infrastructure component] --> B{Which page?} B --> C[Blob Storage] B --> D[Cache / Redis-Valkey] B --> E[ClickHouse] B --> F[Postgres] C --> C1["Official: S3, GCS Native, Azure, MinIO/AIStor, R2"] C --> C2["Community: OCI, Tigris, Other S3-compatible"] D --> D1["Official: Redis >= 7, Valkey >= 8 (self-hosted or managed)"] D --> D2["Community: Dragonfly, KeyDB, Garnet, etc."] E --> E1["Official: ClickHouse Cloud, BYOC, K8s Operator"] E --> E2["Community: Bitnami Helm, Single-container Docker, Other managed"] F --> F1["Official: PostgreSQL >= 12, Aurora PostgreSQL"] F --> F2["Community: AlloyDB, YugabyteDB, etc."] C1 & C2 & D1 & D2 & E1 & E2 & F1 & F2 --> G["Shared SelfHostSupportLevels snippet"] G --> H[GitHub issue / PR for problems or improvements]%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%% flowchart TD A[User picks infrastructure component] --> B{Which page?} B --> C[Blob Storage] B --> D[Cache / Redis-Valkey] B --> E[ClickHouse] B --> F[Postgres] C --> C1["Official: S3, GCS Native, Azure, MinIO/AIStor, R2"] C --> C2["Community: OCI, Tigris, Other S3-compatible"] D --> D1["Official: Redis >= 7, Valkey >= 8 (self-hosted or managed)"] D --> D2["Community: Dragonfly, KeyDB, Garnet, etc."] E --> E1["Official: ClickHouse Cloud, BYOC, K8s Operator"] E --> E2["Community: Bitnami Helm, Single-container Docker, Other managed"] F --> F1["Official: PostgreSQL >= 12, Aurora PostgreSQL"] F --> F2["Community: AlloyDB, YugabyteDB, etc."] C1 & C2 & D1 & D2 & E1 & E2 & F1 & F2 --> G["Shared SelfHostSupportLevels snippet"] G --> H[GitHub issue / PR for problems or improvements]Prompt To Fix All With AI
Reviews (1): Last reviewed commit: "docs: add official/community support sec..." | Re-trigger Greptile