docs: port clickstack-otel-collector skill from upstream#168
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: port clickstack-otel-collector skill from upstream#168mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
3 tasks
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.
Summary
Ports the new
clickstack-otel-collectoragent skill added in upstream PR ClickHouse/clickhouse-docs#6367.Changes
.mintlify/skills/clickstack-otel-collector/SKILL.md(copied verbatim from upstreamstatic/skills/clickstack-otel-collector/SKILL.md), placed alongside the existing skills under.mintlify/skills/.Context
Upstream PR also added:
AgentPromptMDX component (src/components/AgentPrompt/) and a registration inMDXComponents.js. Not ported — Mintlify renders MDX differently and has no equivalent component; the prompt-copy UI would need a separate Mintlify-native implementation.<AgentPrompt />ondocs/use-cases/observability/clickstack/managed-onboarding/setting-up-your-opentelemetry-collector.md. No-op in this repo — that page (and the entiremanaged-onboarding/subdirectory) does not yet exist on the Mintlify side, so there is no slug to update.Ambiguity flagged
setting-up-your-opentelemetry-collectorlands in this repo, the<AgentPrompt …>block needs a Mintlify-compatible replacement (e.g. a<Card>+ code block, or a custom snippet) — the upstream React component cannot be ported as-is.https://clickhouse.com/docs/skills/clickstack-otel-collector/SKILL.mdfromstatic/. Verify the Mintlify deployment exposes.mintlify/skills/**/SKILL.mdat the same public path before the prompt is wired up, otherwise the prompt'scurlURL will need to be adjusted.Note
Low Risk
Documentation-only addition of an agent skill; no runtime, auth, or application code changes in this repo.
Overview
Ports the upstream
clickstack-otel-collectoragent skill into Mintlify by adding.mintlify/skills/clickstack-otel-collector/SKILL.md(verbatim from upstreamstatic/skills/…).The skill is a seven-step runbook for coding agents: confirm the Cloud service, authenticate
clickhousectl, createhyperdx_ingest, runclickhouse/clickstack-otel-collectorvia Docker, time-boxedotelgenverification, and hand off a HyperDX URL. It also documents optional cleanup and upfront permission batching for shell commands.Not in this diff: upstream’s Docusaurus
AgentPromptUI and the managed-onboarding doc that would embed it — those stay unported until Mintlify has an equivalent page and public skill URL.Reviewed by Cursor Bugbot for commit 6ab50dc. Bugbot is set up for automated code reviews on this repo. Configure here.