Skip to content

docs: add assumption-free introductions to integration pages#1

Closed
DYTechWriter wants to merge 1 commit into
mainfrom
docs/issue-339-integration-page-intros
Closed

docs: add assumption-free introductions to integration pages#1
DYTechWriter wants to merge 1 commit into
mainfrom
docs/issue-339-integration-page-intros

Conversation

@DYTechWriter

Copy link
Copy Markdown
Owner

Summary

Part of flanksource#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:

  • Added a 1-2 sentence description of each tool before the Mission Control sentence, so pages are readable without prior knowledge of either the integration or Mission Control
  • Fixed Clickhouse to ClickHouse capitalisation (x12) in clickhouse.mdx
  • Fixed "configuration items" to "config items" in clickhouse.mdx

Pages updated (8 of 29):

Page Path
ArgoCD mission-control/docs/integrations/argo.mdx
Azure mission-control/docs/integrations/azure.mdx
Azure DevOps mission-control/docs/integrations/azure-devops.mdx
ClickHouse mission-control/docs/integrations/clickhouse.mdx
GitHub mission-control/docs/integrations/github.mdx
Kubernetes mission-control/docs/integrations/kubernetes/index.mdx
Prometheus mission-control/docs/integrations/prometheus.mdx
Slack mission-control/docs/integrations/slack.mdx

Vale 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

  • Verify opening paragraph on each updated page reads correctly
  • Confirm no broken MDX compilation in dev server

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 capitalisation (x12) and
'configuration items' -> 'config items' in clickhouse.mdx.

Copy link
Copy Markdown
Owner Author

Superseded by flanksource#510

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant