docs: port new Managed ClickStack getting started guide#200
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: port new Managed ClickStack getting started guide#200mintlify[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 "Get started with Managed ClickStack" guide and its supporting snippets/images from upstream
clickhouse-docsPR #6381 ("New managed clickstack flow").Changes
clickstack/getting-started/managed-getting-started.mdx— maps from Docusaurusdocs/use-cases/observability/clickstack/managed-onboarding/managed-getting-started.md. Slug preserved (/use-cases/observability/clickstack/managed-getting-started).snippets/clickstack/_gather_credentials.mdxandsnippets/clickstack/_create_ingestion_user.mdx(ports of upstream_snippets/_gather_credentials.mdand_snippets/_create_ingestion_user.md).images/clickstack/getting-started/(hackernews_main.png,instrument_app_clickstack_logs.png,instrument_app_clickstack_traces.png,instrument_app_clickstack_sessions.png).Transforms applied
:::note,:::warning,:::tip) to Mintlify (<Note>,<Warning>,<Tip>).<Tabs groupId>+<TabItem value label>with Mintlify<Tabs>+<Tab title>.<VerticalStepper headerLevel="h2">with Mintlify<Steps>/<Step>.<Image img={importedPng} ... />with Mintlify<Image img="/images/..." ... />(using the existing/snippets/components/Image.jsxcomponent, matching the convention used inclickstack/getting-started/managed.mdx).pagination_prev,pagination_next,custom_edit_url,hide_advert) and addedsidebarTitle. Keptunlisted: truesince the upstream file is whitelisted inplugins/floating-pages-exceptions.txt— the corresponding Docusaurus change in that file has no Mintlify equivalent and was intentionally not ported.Ambiguities / TODOs
The "Further reading" section references three pages that have not yet been ported to the Mintlify repo:
/use-cases/observability/clickstack/monitoring-kubernetes/use-cases/observability/clickstack/monitoring-aws-cloudwatch-logs/use-cases/observability/clickstack/tuning-clickstack-schemaThese bullets have been temporarily removed and a
{/* TODO */}comment left in their place so they can be reinstated once the correspondingmanaged-onboarding/*pages are migrated. Two upstream links did have direct Mintlify equivalents and were kept (/clickstack/managing/production,/clickstack/ingesting-data/collector#securing-the-collector).The Docusaurus link to
/use-cases/observability/clickstack/ingesting-data/opentelemetrywas rewritten to the Mintlify root-relative form/clickstack/ingesting-data/opentelemetry, matching the slug of the existing Mintlify page.Context
Triggered by merge commit
16eb3a83onclickhouse/clickhouse-docsmain.Note
Low Risk
Documentation-only content migration with no application or infrastructure code changes; minor risk from placeholder passwords in examples and deferred cross-links.
Overview
Adds a new Get started with Managed ClickStack guide (
managed-getting-started.mdx) that walks through credentials, a dedicatedhyperdx_ingestuser, gateway collector setup (Docker ClickStack collector or custom YAML with ClickHouse/rrweb exporters), instrumenting the HackerNews Analyzer sample app, and exploring logs/traces/session replay in ClickStack.The page is ported from upstream Docusaurus with Mintlify components (
Steps,Tabs,Note/Warning/Tip, staticImagepaths) and pulls in two new snippets:_gather_credentials.mdxand_create_ingestion_user.mdx. It staysunlisted: truewith the original slug preserved; three “Further reading” links are omitted pending migration, with a TODO comment left in place.Reviewed by Cursor Bugbot for commit e383d3c. Bugbot is set up for automated code reviews on this repo. Configure here.