docs: port ClickStack nurture flow / OTel collector updates#114
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: port ClickStack nurture flow / OTel collector updates#114mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
3 tasks
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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 ClickHouse/clickhouse-docs#6335 (ClickStack - Nurture flow - Otel collector) to the Mintlify docs.
Changes
BetaBadgeand the "Beta feature" note fromproducts/clickstack/deployment/managed.mdxandproducts/clickstack/getting-started/managed.mdx(Managed ClickStack is now GA).products/clickstack/example-datasets/otelgen.mdx. Slug preserved as/use-cases/observability/clickstack/getting-started/otelgen.products/clickstack/managed-onboarding/setting-up-your-opentelemetry-collector.mdx(keptunlisted: trueas in source — not added to navigation). Slug preserved as/use-cases/observability/clickstack/setting-up-your-opentelemetry-collector.clickstack-cloud-v2.png,clickstack-search.png,clickstack-start-exploring.png,clickstack-start-ingestion.png.otelgentoproducts/clickstack/navigation.jsonunder Sample datasets.Conversion notes / ambiguities
<VerticalStepper headerLevel="h3">was converted to Mintlify<Steps>/<Step>.<Tabs groupId="...">was converted to plain Mintlify<Tabs>/<Tab title="...">(Mintlify Tabs don't support sharedgroupIdstate).:::noteblocks were converted to Mintlify<Note>components./use-cases/observability/clickstack/ingesting-data/otel-collector#...were retargeted to the equivalent Mintlify route/products/clickstack/ingesting-data/collector#....src/theme/DocItem/TOC/Desktop/index.jsis Docusaurus-only theming and was not ported.setting-up-your-opentelemetry-collectorpage is markedunlisted: trueupstream (intended to be reachable from the ClickStack UI rather than nav); replicated by not adding it tonavigation.json. Flagging in case it should also be linked from the deployment/managed page.Note
Low Risk
Documentation-only changes (copy, nav, and new guides); no application or ingestion runtime code.
Overview
Ports the ClickStack nurture / OpenTelemetry collector documentation into Mintlify and treats Managed ClickStack as GA on the main getting-started and deployment pages.
Managed ClickStack GA: Removes the
BetaBadgecomponent and the beta callout fromproducts/clickstack/getting-started/managed.mdxandproducts/clickstack/deployment/managed.mdx.Synthetic telemetry: Adds
products/clickstack/example-datasets/otelgen.mdxwith Managed vs Open Source tabs for installingotelgen, sending OTLP logs/traces/metrics to the collector (including optionalOTLP_AUTH_TOKEN/ API key headers), and verifying data in the UI. Lists the page on the sample datasets index and inproducts/clickstack/navigation.json.Collector onboarding: Adds
products/clickstack/managed-onboarding/setting-up-your-opentelemetry-collector.mdx(unlisted: true, not in nav) with steps to gather Cloud credentials, createhyperdx_ingest, runclickhouse/clickstack-otel-collector, verify withotelgen, and confirm ingestion in the ClickStack UI (new screenshots referenced in the PR description).Reviewed by Cursor Bugbot for commit a68cd64. Bugbot is set up for automated code reviews on this repo. Configure here.