docs(ci): document the CI tab, the PR CI view, and span ingestion - #344
Merged
Merged
Conversation
Adds a top-level CI tab covering the two product surfaces and the setup for both ingestion lanes. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
- Updated ci/pull-requests.mdx - Updated docs.json Mintlify-Source: dashboard-editor
- Updated ci/pull-requests.mdx Mintlify-Source: dashboard-editor
- Updated ci/pull-requests.mdx - Created Pull-Requests-List.png Mintlify-Source: dashboard-editor
- Updated ci/pull-requests.mdx Mintlify-Source: dashboard-editor
- Updated ci/pull-requests.mdx - Created pull-request-waterfall-view.png Mintlify-Source: dashboard-editor
- Updated ci/pull-requests.mdx Mintlify-Source: dashboard-editor
- Updated ci/pull-requests.mdx Mintlify-Source: dashboard-editor
- Updated ci/pull-requests.mdx Mintlify-Source: dashboard-editor
- Updated ci/pull-requests.mdx Mintlify-Source: dashboard-editor
- Updated ci/pull-requests.mdx - Updated ci/ci-tab.mdx Mintlify-Source: dashboard-editor
- Updated ci/ci-tab.mdx - Created ci-jobs-list.jpeg Mintlify-Source: dashboard-editor
- Updated ci/ci-tab.mdx - Created ci-job-performance.png Mintlify-Source: dashboard-editor
- Updated ci/ci-tab.mdx Mintlify-Source: dashboard-editor
- Updated ci/ci-tab.mdx - Deleted ci/commit-traces.mdx - Updated docs.json Mintlify-Source: dashboard-editor
- Updated ci/index.mdx Mintlify-Source: dashboard-editor
- Updated ci/index.mdx Mintlify-Source: dashboard-editor
- Updated ci/index.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/index.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/index.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/index.mdx Mintlify-Source: dashboard-editor
Resolve docs.json nav conflict: main restructured the tabs (Flaky Tests -> Tests, Trunk Workspaces -> Workspaces, Code Quality CLI folded into Setup, Dynamic CI moved up). Kept main's structure and re-inserted the new CI tab ahead of Dynamic CI. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
- Move the four CI screenshots from the repo root into assets/ci/, matching the layout every other section uses, and give them real alt text instead of the filename echo. - Add ci/commit-traces, which three pages already linked to but which was never written, and put it in the CI tab nav. - Drop the two <Frame> blocks pointing at assets/ci/get-started/ screenshots that were never committed; the surrounding steps already describe the navigation. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
- Updated ci/get-started/index.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/index.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/index.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/index.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/index.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/index.mdx Mintlify-Source: dashboard-editor
- Created assets/icons/buildkite.svg Mintlify-Source: dashboard-editor
- Updated ci/get-started/buildkite.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/buildkite.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/buildkite.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/buildkite.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/buildkite.mdx Mintlify-Source: dashboard-editor
- Created create-api-key.png Mintlify-Source: dashboard-editor
- Updated ci/get-started/buildkite.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/buildkite.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/buildkite.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/buildkite.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/buildkite.mdx Mintlify-Source: dashboard-editor
- Updated ci/get-started/buildkite.mdx - Created images/buildkite-otel.png Mintlify-Source: dashboard-editor
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.
Adds a top-level CI tab to the docs, covering the two places the CI product shows up in the app and how to get data into it.
ci/indexci/get-started/indexci/get-started/github-actionsci/get-started/buildkiteci/pull-requestsci/ci-tabci/commit-tracesDecisions worth reviewing
A new top-level tab, not a group inside an existing one. The product is its own top-navbar tab in the app, and mirroring that keeps the docs navigable by someone looking at the app. Folding it into the Dynamic CI tab was the alternative, and it's wrong: the two products are deliberately decoupled flags (
showCiDashboardvsshowDynamicCI), so an org can have either without the other. Putting them under one tab would imply otherwise. It sits immediately before Dynamic CI so the two CI products are adjacent.Public, not group-gated. Dynamic CI's page carries
groups: ["dynamic-ci"]and is served only to readers whose docs JWT lists it. Gating these the same way would need a companion trunk2 PR —docsGroupsForSessioninmintlify-docs.tsonly ever emitsdynamic-citoday, and reusing that group would show CI docs to exactly the wrong set of orgs. Shipping public avoids a cross-repo dependency for docs that describe a product customers are already being onboarded onto. Easy to gate later if that's wrong.commit-tracesis its own page rather than duplicated prose. The waterfall is literally one view with two hosts (the PR detail CI tab and the CI tab's job history), so describing it twice would guarantee drift. Both pages link to it.Definitions are stated, because the numbers are not self-evident. Pass rate excludes cancelled and skipped from both halves; run count includes zero-duration runs while duration percentiles cannot. That asymmetry is visible in the UI (a duration chart's count sits below the run count) and reads as a bug unless the docs say why.
Scope. Failures, Monitors, Logs, Pricing and Kiln sub-tabs are deliberately left out — Failures renders empty in production today and Logs is a placeholder. A reader will see tabs these docs don't mention; worth a follow-up once those are real.
Two things I could not confirm
The Buildkite ingest host. I published
https://api.trunk.io/v2/ci/buildkite. The route is mounted onpublicApiDomain, but per ADR-0013 onlyprivate.api.<domain>has a CloudFront origin today and the apex is a later cutover. Both hosts return403to an unauthenticated POST, which proves the edge is enforcing but not which host external callers should be given. If the apex isn't live for customers yet, this one string needs changing (ci/get-started/buildkite.mdx, two occurrences).Buildkite's own UI labels.
CONTRIBUTING.mdasks that nav paths be walked in the live product. I verifiedSettings→Notification Servicesand the--opentelemetry-tracingagent flag against Buildkite's current docs, not their UI. Someone with a Buildkite org admin seat should confirm the OpenTelemetry Tracing service name and the URL/Headers field labels.Separately and not fixed here:
docs/trd/ci-data-ingestion/per-provider-ingestion.mdin trunk2 still says the agent flag is--tracing-backend opentelemetry. Buildkite's current docs and the comment inhandlers.rsboth say--opentelemetry-tracing. Docs here use the current flag; the TRD needs its own fix.Screenshots
Eight
<Frame>slots are in place pointing at/assets/ci/…, currently unfilled:get-started/ci-intelligence-toggle.png— Settings → Repositories, CI Intelligence columnget-started/org-api-token.png— Settings → Organization → General, API Token rowpull-requests/pr-list.png— the/pullstable with CI + merge-queue columnspull-requests/pr-detail.png— PR detail with attempt picker and CI tabci-tab/jobs-list.png— Jobs index with repo pickerci-tab/job-detail.png— job page stat strip + pass/fail chartci-tab/overview.png— in-flight boxes + concurrency chartcommit-traces/waterfall.png— a trace with several workflow lanes and visible queue stripesDon't merge before these land — the pages render broken images until they do.
🤖 Generated with Claude Code