docs: add assumption-free introductions to integration pages#510
docs: add assumption-free introductions to integration pages#510DYTechWriter wants to merge 1 commit into
Conversation
|
@DYTechWriter is attempting to deploy a commit to the Flanksource Team on Vercel. A member of the Team first needs to authorize it. |
✅ Deploy Preview for canarychecker canceled.
|
|
Warning Review limit reached
More reviews will be available in 52 minutes and 27 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (8)
WalkthroughThis PR expands integration documentation for Mission Control by replacing generic introductory sentences with detailed descriptions of specific capabilities for each service, and standardizes ClickHouse naming conventions throughout its integration guide. ChangesIntegration Documentation Updates
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@mission-control/docs/integrations/argo.mdx`:
- Line 17: The opening paragraph in the ArgoCD integration overview must be
rewritten to start with "Mission Control integrates with ArgoCD to..." and be
2–3 sentences long; either reorder the current two sentences so the Mission
Control integration sentence comes first and then follow with the platform
description, or combine them into a single sentence that begins "Mission Control
integrates with ArgoCD to..." (refer to the ArgoCD integration overview text in
mission-control/docs/integrations/argo.mdx and update that paragraph
accordingly).
In `@mission-control/docs/integrations/clickhouse.mdx`:
- Around line 455-456: The Card component title "ClickHouse Scraper Reference"
and the linked scraper guide title/frontmatter "Clickhouse" have inconsistent
capitalization; standardize both to "ClickHouse" by updating the Card title or
(preferably) updating the scraper guide's frontmatter/title and headings from
"Clickhouse" to "ClickHouse" so both documents match; look for the Card element
with title "ClickHouse Scraper Reference" and the scraper guide
frontmatter/title string "Clickhouse" and make the capitalization consistent
across both.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: deba5dbb-8f06-4522-9f7c-db3b6551d6f4
📒 Files selected for processing (8)
mission-control/docs/integrations/argo.mdxmission-control/docs/integrations/azure-devops.mdxmission-control/docs/integrations/azure.mdxmission-control/docs/integrations/clickhouse.mdxmission-control/docs/integrations/github.mdxmission-control/docs/integrations/kubernetes/index.mdxmission-control/docs/integrations/prometheus.mdxmission-control/docs/integrations/slack.mdx
| </CapabilityBadges> | ||
|
|
||
| Mission Control integrates with ArgoCD to provide visibility into your GitOps deployments. | ||
| ArgoCD is a declarative GitOps continuous delivery tool for Kubernetes that keeps your cluster in sync with application definitions stored in Git. Mission Control integrates with ArgoCD to track sync status, resource health, and changes across your GitOps deployments. |
There was a problem hiding this comment.
All integration overviews must start with "Mission Control integrates/provides" per coding guidelines.
All 7 integration pages in this PR follow the same pattern: platform description first, then Mission Control integration description. However, the coding guidelines explicitly require that "Integration overview must be 2-3 sentences starting with 'Mission Control integrates with [Platform] to...'"
To comply with the guideline, either:
- Reorder sentences so Mission Control's integration is mentioned first, followed by the platform description
- Combine both into a single sentence that starts with "Mission Control integrates with [Platform]..."
This ensures consistency across all integration documentation.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@mission-control/docs/integrations/argo.mdx` at line 17, The opening paragraph
in the ArgoCD integration overview must be rewritten to start with "Mission
Control integrates with ArgoCD to..." and be 2–3 sentences long; either reorder
the current two sentences so the Mission Control integration sentence comes
first and then follow with the platform description, or combine them into a
single sentence that begins "Mission Control integrates with ArgoCD to..."
(refer to the ArgoCD integration overview text in
mission-control/docs/integrations/argo.mdx and update that paragraph
accordingly).
Source: Coding guidelines
Part of flanksource#339. Adds 1-2 sentence tool descriptions before the Mission Control sentence on each integration landing page, so visitors arriving directly (e.g. via search) have context without needing to read the overview page first. Also fixes Clickhouse -> ClickHouse capitalization (x12) and 'configuration items' -> 'config items' in clickhouse.mdx.
DYTechWriter
force-pushed
the
docs/issue-339-integration-page-intros
branch
from
c2acd15 to
e333bed
Compare
1 participant
Summary
Part of #339. This PR updates 8 of 29 integration landing pages.
Each integration landing page previously opened with a single line like "Mission Control integrates with X to do Y" with no context for what X actually is.
Changes:
Pages updated (8 of 29):
mission-control/docs/integrations/argo.mdxmission-control/docs/integrations/azure.mdxmission-control/docs/integrations/azure-devops.mdxmission-control/docs/integrations/clickhouse.mdxmission-control/docs/integrations/github.mdxmission-control/docs/integrations/kubernetes/index.mdxmission-control/docs/integrations/prometheus.mdxmission-control/docs/integrations/slack.mdxVale lint
0 new errors introduced. 10 pre-existing errors remain across 3 files (argo, azure, clickhouse, kubernetes), all pre-dating this PR and tracked separately.
Test plan
Summary by CodeRabbit