-
Notifications
You must be signed in to change notification settings - Fork 4
Improve MCP devex #478
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Improve MCP devex #478
Changes from all commits
Commits
Show all changes
27 commits
Select commit
Hold shift + click to select a range
c551796
Restructure MCP server documentation for better navigation
JakeSCahill 841e6ee
Use single-sourced key-terms partial in concepts page
JakeSCahill 836129d
Temporary playbook update to build from pending branch
JakeSCahill 278e1c0
Update personas
JakeSCahill 802cca7
Lowercase
JakeSCahill c83adf4
Merge branch 'main' into improve-mcp-devex
JakeSCahill b76d5b9
Align cloud-docs MCP testing and structure with rp-connect-docs
JakeSCahill ca765a1
Reorganize cloud-docs MCP pages to match rp-connect-docs structure
JakeSCahill 9cb5376
Merge branch 'improve-mcp-devex' of https://github.com/redpanda-data/…
JakeSCahill a91ef84
Add personas and update includes
JakeSCahill cc5b559
Restructure
JakeSCahill 1c17637
Add anchors
JakeSCahill 19feee2
three learning objectives max
JakeSCahill 0ec367a
Restructure
JakeSCahill 01be057
Update overview.adoc
JakeSCahill 671318d
Make title action-based
JakeSCahill 6e2f3d9
Merge branch 'improve-mcp-devex' of https://github.com/redpanda-data/…
JakeSCahill 230e070
Remove toc
JakeSCahill 574fd71
Apply suggestions
JakeSCahill ef07fcb
Merge branch 'main' into improve-mcp-devex
JakeSCahill 0db00fb
Remove Jira section (not available in Cloud)
JakeSCahill ffb2ddc
Merge branch 'improve-mcp-devex' of https://github.com/redpanda-data/…
JakeSCahill e1b8634
Update modules/ai-agents/pages/mcp/remote/best-practices.adoc
JakeSCahill ccccad0
Update modules/ai-agents/pages/mcp/overview.adoc
JakeSCahill c490697
Rename the local MCP server
JakeSCahill c5337fa
Merge branch 'improve-mcp-devex' of https://github.com/redpanda-data/…
JakeSCahill 4f8a3f5
Fix links
JakeSCahill File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| # Redpanda Cloud Documentation Personas | ||
| # | ||
| # These personas represent the target audience for Redpanda Cloud documentation. | ||
| # Use these when assigning :personas: attributes to documentation pages. | ||
|
|
||
| schema_version: "1.0" | ||
| repository: cloud-docs | ||
|
|
||
| personas: | ||
| - id: app_developer | ||
| name: Application Developer | ||
| description: Builds applications that produce and consume data from Redpanda Cloud | ||
| experience_level: intermediate | ||
| goals: | ||
| - Connect applications to Redpanda Cloud clusters | ||
| - Produce and consume messages reliably | ||
| - Implement proper error handling and retries | ||
| - Optimize client performance | ||
| pain_points: | ||
| - Authentication and connection configuration | ||
| - Understanding Kafka client options | ||
| - Debugging connectivity issues | ||
| - Choosing the right client library | ||
| content_preferences: | ||
| - Working code examples in multiple languages | ||
| - Connection configuration templates | ||
| - Client library comparisons | ||
| - Performance tuning guides | ||
| typical_content_types: | ||
| - how-to | ||
| - tutorial | ||
| - reference | ||
|
|
||
| - id: platform_admin | ||
| name: Platform Administrator | ||
| description: Manages Redpanda Cloud clusters, users, security, and billing | ||
| experience_level: intermediate | ||
| goals: | ||
| - Provision and configure clusters | ||
| - Manage user access and security | ||
| - Monitor cluster health and usage | ||
| - Control costs and optimize resources | ||
| pain_points: | ||
| - Complex security configuration | ||
| - Understanding billing and usage metrics | ||
| - Managing access across teams | ||
| - Capacity planning | ||
| content_preferences: | ||
| - Step-by-step administration guides | ||
| - Security best practices | ||
| - Billing and cost optimization tips | ||
| - Monitoring and alerting setup | ||
| typical_content_types: | ||
| - how-to | ||
| - reference | ||
| - best-practices | ||
|
|
||
| - id: data_engineer | ||
| name: Data Engineer | ||
| description: Builds data pipelines using managed connectors and Redpanda Connect | ||
| experience_level: intermediate | ||
| goals: | ||
| - Set up managed connectors to move data between systems | ||
| - Transform and route data reliably | ||
| - Monitor connector and pipeline health | ||
| - Handle errors and retries | ||
| pain_points: | ||
| - Connector configuration complexity | ||
| - Debugging failed connectors | ||
| - Schema management and evolution | ||
| - Performance tuning | ||
| content_preferences: | ||
| - Connector setup guides | ||
| - Transformation examples | ||
| - Error handling patterns | ||
| - Monitoring and troubleshooting | ||
| typical_content_types: | ||
| - how-to | ||
| - cookbook | ||
| - troubleshooting | ||
|
|
||
| - id: ai_agent_developer | ||
| name: AI Agent Developer | ||
| description: Builds AI agents and integrations using MCP tools and LLM frameworks | ||
| experience_level: intermediate | ||
| goals: | ||
| - Create MCP tools that AI assistants can discover and use | ||
| - Deploy MCP servers to Redpanda Cloud | ||
| - Integrate with AI/LLM applications | ||
| - Debug agent-tool interactions | ||
| pain_points: | ||
| - MCP configuration syntax | ||
| - Testing tools before deployment | ||
| - Limited AI-specific examples | ||
| content_preferences: | ||
| - Working code examples with AI context | ||
| - Testing and debugging workflows | ||
| - Integration patterns | ||
| typical_content_types: | ||
| - tutorial | ||
| - how-to | ||
| - cookbook | ||
| - best-practices | ||
|
|
||
| - id: streaming_developer | ||
| name: Streaming Platform Developer | ||
| description: Works with Kafka/Redpanda streaming systems at scale | ||
| experience_level: advanced | ||
| goals: | ||
| - Build event-driven architectures on Redpanda Cloud | ||
| - Optimize for high throughput and low latency | ||
| - Implement exactly-once semantics | ||
| - Migrate from self-hosted Kafka | ||
| pain_points: | ||
| - Consumer group behavior differences | ||
| - Schema registry configuration | ||
| - Performance at scale | ||
| - Migration complexity | ||
| content_preferences: | ||
| - Advanced configuration options | ||
| - Performance tuning guides | ||
| - Migration documentation | ||
| - Architecture patterns | ||
| typical_content_types: | ||
| - concepts | ||
| - how-to | ||
| - reference | ||
| - best-practices | ||
|
|
||
| - id: evaluator | ||
| name: Technical Evaluator | ||
| description: Assessing Redpanda Cloud for their organization | ||
| experience_level: beginner | ||
| goals: | ||
| - Understand Redpanda Cloud capabilities quickly | ||
| - Evaluate fit for specific use cases | ||
| - Understand pricing and billing | ||
| - Compare with alternatives | ||
| pain_points: | ||
| - Hard to find high-level overview | ||
| - Too much detail too soon | ||
| - Unclear pricing structure | ||
| - Missing comparison information | ||
| content_preferences: | ||
| - High-level overviews | ||
| - Use case examples | ||
| - Quick start guides | ||
| - Pricing documentation | ||
| typical_content_types: | ||
| - overview | ||
| - concepts | ||
| - tutorial | ||
| - get-started | ||
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you have it go through the entire cloud-docs repo to generate these personas, or just the pages in this PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The entire repo.