Trim repeated Prerequisites boilerplate in guides-k8s#1025
Merged
Conversation
Cluster, kubectl, and operator-installed bullets were restated on every how-to page even though the reader already covers them earlier in the journey (Deploy the operator, Run MCP servers). Keep only what is specific to each page.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reduces duplicated “Prerequisites” boilerplate across several Kubernetes how-to guides by removing repeated cluster/kubectl/operator-install bullets that are already covered earlier in the guides-k8s journey.
Changes:
- Condenses
run-mcp-k8s.mdxprerequisites into a single pointer to “Deploy the operator”. - Removes repeated baseline prerequisites from
remote-mcp-proxy.mdxandmcp-server-entry.mdx, keeping only page-specific requirements. - Removes a redundant
kubectlprerequisite fromconnect-clients.mdx.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/toolhive/guides-k8s/run-mcp-k8s.mdx | Replaces the repeated prerequisite bullet list with a single link to the operator deployment guide. |
| docs/toolhive/guides-k8s/remote-mcp-proxy.mdx | Trims baseline cluster/operator prerequisites, leaving only OIDC IdP and remote-server requirements. |
| docs/toolhive/guides-k8s/mcp-server-entry.mdx | Removes baseline cluster/operator prerequisites, leaving only the remote-server transport requirement. |
| docs/toolhive/guides-k8s/connect-clients.mdx | Drops the redundant kubectl bullet while keeping page-specific ingress requirements. |
ChrisJBurns
previously approved these changes
Jul 9, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
ChrisJBurns
approved these changes
Jul 9, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Several guides-k8s how-to pages restated the same cluster/kubectl/operator-installed boilerplate that's already covered earlier in the section (Deploy the operator, Run MCP servers). This trims each page's Prerequisites section down to what's actually specific to it, following the pattern already used on
rate-limiting.mdx,redis-session-storage.mdx, and the four auth pages fixed in #1014.run-mcp-k8s.mdx: condensed four boilerplate bullets into one line pointing to Deploy the operatorremote-mcp-proxy.mdx: dropped cluster/permissions/kubectl/operator bullets, kept only the OIDC provider and remote server requirementsmcp-server-entry.mdx: dropped the same boilerplate, kept only the remote server transport requirementconnect-clients.mdx: dropped the redundantkubectlbullet (cluster/Ingress bullets are page-specific and stay)deploy-operator.mdxandquickstart.mdxare left as-is since they're the actual first-touch pages where that baseline is genuinely needed.I also did a quick check of
guides-cli,guides-vmcp, andguides-registryand didn't find the same repeated-boilerplate pattern worth fixing there.Type of change
Related issues/PRs
Closes #1015
Submitter checklist
Content and formatting
Reviewer checklist
Content