Update K8s docs to reference newer resource types #445
Conversation
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
- Add mentions of other resource types where appropriate - Add/fix anchors to CRD reference Signed-off-by: Dan Barr <[email protected]>
|
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 updates several Kubernetes documentation files to reference newer resource types (MCPRemoteProxy, VirtualMCPServer) alongside the existing MCPServer resource type, and fixes link anchors to point to the specific CRD sections in the reference documentation.
Changes:
- Updated multiple documentation pages to mention MCPServer, MCPRemoteProxy, and VirtualMCPServer resource types where appropriate
- Fixed CRD reference link anchors to include the specific API version (e.g.,
#apiv1alpha1mcpserverinstead of just#mcpserver) - Added tabbed examples in logging.mdx and customize-tools.mdx to show configuration for different resource types
- Reordered sidebar items to place remote-mcp-proxy before connect-clients
- Updated title in logging.mdx from "Set up logging" to "Audit logging"
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.ts | Reordered sidebar navigation to move remote-mcp-proxy guide before connect-clients guide |
| docs/toolhive/guides-vmcp/configuration.mdx | Updated CRD reference link anchors to include API version |
| docs/toolhive/guides-k8s/telemetry-and-metrics.mdx | Updated to reference both MCPServer and MCPRemoteProxy resource types, fixed CRD link anchor |
| docs/toolhive/guides-k8s/run-mcp-k8s.mdx | Fixed CRD reference link anchors to include API version |
| docs/toolhive/guides-k8s/remote-mcp-proxy.mdx | Fixed CRD reference link anchor for MCPRemoteProxy |
| docs/toolhive/guides-k8s/logging.mdx | Changed title, added tabbed examples for MCPServer, MCPRemoteProxy, and VirtualMCPServer |
| docs/toolhive/guides-k8s/intro.mdx | Updated overview to describe all three CRD types (MCPServer, MCPRemoteProxy, VirtualMCPServer) |
| docs/toolhive/guides-k8s/index.mdx | Updated experimental notice to reference all CRDs instead of just MCPServer |
| docs/toolhive/guides-k8s/deploy-registry.mdx | Fixed CRD reference link anchor for MCPRegistry |
| docs/toolhive/guides-k8s/customize-tools.mdx | Added tabbed examples for MCPServer and MCPRemoteProxy, fixed CRD link anchor |
| docs/toolhive/guides-k8s/connect-clients.mdx | Expanded service naming documentation to cover all three resource types, updated formatting conventions |
Signed-off-by: Dan Barr <[email protected]>
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
Type of change
Submitter checklist
Content and formatting
Reviewer checklist
Content