Skip to content

docs(platform): correct data worker enforcement docs (charts, On-demand tag, per-sync estimates) - #87017

Draft
Ian Alton (ian-at-airbyte) wants to merge 1 commit into
masterfrom
devin/1790394183-dw-enforcement-docs
Draft

Ian Alton (ian-at-airbyte) wants to merge 1 commit into
masterfrom
devin/1790394183-dw-enforcement-docs

Conversation

@ian-at-airbyte

Copy link
Copy Markdown
Contributor

What

Follow-up to #86505 / #86506 for DOCS-81. Fixes the remaining places where the data worker docs don't match what the platform ships, verified against airbyte-platform-internal master.

How

  • Per-sync table: File and Custom ~0.2 → ~0.25. They have no dedicated resource profile and fall back to the generic defaults in airbyte-server/application.yml (0.5 + 1 + 0.5 = 2 CPU / 8). API stays ~0.2 (0.8 + 0.3 + 0.3 = 1.4 / 8 = 0.175), Database stays 0.5.
  • Org usage chart: it renders one bar per interval (the region's peak), not a stacked-by-workspace chart; the workspace breakdown lives in the hover tooltip (which also warns that per-workspace peaks can sum above the region peak). Reference line is now labelled Allocated capacity (settings.organization.usage.graph.committedCapacity), not "Contracted capacity".
  • Workspace usage chart: it's the same peak bar chart with 1D/1W/1M/1Q/1Y + "Compare to previous period" and a Region: … · capacity … DW header, not a 7-day hourly line graph.
  • Queued syncs: "Queued syncs don't consume capacity while they wait" → "don't run, so they don't use data workers while they wait" (the reservation model isn't quite as absolute as the old sentence).
  • Queued icon: "orange hourglass" → "yellow hourglass" (QueuedIcon uses the yellow theme colors); connection-status page also now says the queue is per region.
  • Images: on-demand-tag.png (both copies) still showed the old "Burst" label — replaced with a render of the current tag (same gradient/star/On-demand string). data-worker-usage.png had the "Contracted capacity" reference label; edited in place to "Allocated capacity". The rest of that screenshot is unchanged.

Review guide

  1. docs/platform/cloud/managing-airbyte-cloud/manage-data-workers.md
  2. docs/platform/cloud/managing-airbyte-cloud/review-connection-status.md
  3. the three PNGs

User Impact

Docs match the current Pro/Teams/Flex UI and per-sync estimates.

Notes: review-connection-status.md has pre-existing MD060 table-alignment lint errors on lines I didn't touch; left as is.

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

Link to Devin session: https://app.devin.ai/sessions/3e52f3291240490391d3659156137bbd
Open in Devin Desktop: https://app.devin.ai/desktop/session/3e52f3291240490391d3659156137bbd?variant=devin
Requested by: Ian Alton (@ian-at-airbyte)

…rts, tag, and per-sync estimates

Co-Authored-By: ian.alton@airbyte.io <ian.alton@airbyte.io>
@devin-ai-integration

Copy link
Copy Markdown
Contributor

I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".

  • Disable automatic comment, CI, and merge conflict monitoring

@octavia-bot
octavia-bot Bot marked this pull request as draft September 26, 2026 03:45
@linear-code

linear-code Bot commented Sep 26, 2026

Copy link
Copy Markdown

DOCS-81

@octavia-bot

octavia-bot Bot commented Sep 26, 2026

Copy link
Copy Markdown
Contributor

Note

📝 PR Converted to Draft

More info...

Thank you for creating this PR. As a policy to protect our engineers' time, Airbyte requires all PRs to be created first in draft status. Your PR has been automatically converted to draft status in respect for this policy.

As soon as your PR is ready for formal review, you can proceed to convert the PR to "ready for review" status by clicking the "Ready for review" button at the bottom of the PR page.

To skip draft status in future PRs, please include [ready] in your PR title or add the skip-draft-status label when creating your PR.

@github-actions

Copy link
Copy Markdown
Contributor

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

💡 Show Tips and Tricks

PR Slash Commands

Airbyte Maintainers (that's you!) can execute the following slash commands on your PR:

  • 🛠️ Quick Fixes
    • /format-fix - Fixes most formatting issues.
    • /bump-version - Bumps connector versions, scraping changelog description from the PR title.
      • Bump types: patch (default), minor, major, major_rc, rc, promote.
      • The rc type is a smart default: applies minor_rc if stable, or bumps the RC number if already RC.
      • The promote type strips the RC suffix to finalize a release.
      • Example: /bump-version type=rc or /bump-version type=minor
    • /bump-progressive-rollout-version - Alias for /bump-version type=rc. Bumps with an RC suffix and enables progressive rollout.
  • ❇️ AI Testing and Review (internal link: AI-SDLC Docs):
    • /ai-prove-fix - Runs prerelease readiness checks, including testing against customer connections.
    • /ai-canary-prerelease - Rolls out prerelease to 5-10 connections for canary testing.
    • /ai-review - AI-powered PR review for connector safety and quality gates.
    • /ai-breaking-change-review - Assists the breaking-change reviewers: whether the change needs to be breaking, destination data-loss risk, and whether the migration guide, metadata message, and docs let users upgrade safely.
  • 📝 AI Documentation:
    • /ai-docs-review - AI-powered documentation review for PRs with connector changes.
    • /ai-create-docs-pr - Creates a documentation PR for connector changes, stacked on the current PR.
  • 🚀 Connector Releases:
    • /publish-connectors-prerelease - Publishes pre-release connector builds (tagged as {version}-preview.{git-sha}) for all modified connectors in the PR.
    • /enable-autopilot-rollouts - Enables autopilot progressive rollouts for the modified connector(s) in the PR, remediating "autopilot rollouts not enabled for {connector-name}" auto-merge blockers. Sets defaultRolloutMode: autopilot and enableProgressiveRollout: true, preserving any existing autopilotConfig.
      • Optional args: connector=<CONNECTOR_NAME> (defaults to the modified connectors in the PR), strategy=fast|slow|default (defaults to fast).
      • Example: /enable-autopilot-rollouts or /enable-autopilot-rollouts connector=source-faker strategy=slow
  • ☕️ JVM connectors:
    • /update-connector-cdk-version connector=<CONNECTOR_NAME> - Updates the specified connector to the latest CDK version.
      Example: /update-connector-cdk-version connector=destination-bigquery
  • 🐍 Python connectors:
    • /poe connector source-example lock - Run the Poe lock task on the source-example connector, committing the results back to the branch.
    • /poe source example lock - Alias for /poe connector source-example lock.
    • /poe source example use-cdk-branch my/branch - Pin the source-example CDK reference to the branch name specified.
    • /poe source example use-cdk-latest - Update the source-example CDK dependency to the latest available version.
  • ⚙️ Admin commands:
    • /force-merge reason="<REASON>" - Force merges the PR using admin privileges, bypassing CI checks. Requires a reason.
      Example: /force-merge reason="CI is flaky, tests pass locally"
📚 Show Repo Guidance

Helpful Resources

📝 Edit this welcome message.

@github-actions

Copy link
Copy Markdown
Contributor

Deploy preview for airbyte-docs ready!

Project:airbyte-docs
Status: ✅  Deploy successful!
Preview URL:https://airbyte-docs-2uzpihn9n-airbyte-growth.vercel.app
Latest Commit:f904b99

Deployed with vercel-action

This branch has not been deployed

No deployments
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