Skip to content

docs(source-incident-io): improve documentation accuracy and add escalations stream#74073

Draft
devin-ai-integration[bot] wants to merge 1 commit intomasterfrom
devin/1772141683-docs-incident-io
Draft

docs(source-incident-io): improve documentation accuracy and add escalations stream#74073
devin-ai-integration[bot] wants to merge 1 commit intomasterfrom
devin/1772141683-docs-incident-io

Conversation

@devin-ai-integration
Copy link
Contributor

What

Improves the Incident.io source connector documentation, triggered by #74072 which added the escalations stream and migrated incident_roles to the v2 API.

⚠️ I am an AI (Devin) proposing documentation updates based on a review of the connector source code and the incident.io API docs. Reviewers may merge, modify, or close this PR as they see fit.

Requested by: bot_apk (apk@cognition.ai)
Link to Devin run: https://app.devin.ai/sessions/91cde89703274cae981b49ef04c9a366

How

Single file change: docs/integrations/sources/incident-io.md

Fixes to incorrect information:

  • Section title said "Set up the Adjust source connector" — fixed to "Incident.io"
  • Step 2 had typo "Incdient.io" — fixed to "Incident.io"
  • Prerequisites incorrectly stated API keys are "under the extends heading" — corrected to Settings > API keys with a link to app.incident.io/settings/api-keys, verified against incident.io auth docs
  • Step numbering jumped from 4 to 7 — fixed to sequential (4, 5)

Added missing information:

  • Added escalations stream (new in v0.1.21, uses DefaultPaginator) to the Streams table
  • Added links to the incident.io API reference and authentication docs

Improved clarity:

  • Replaced subjective intro ("important streams are…") with a factual description
  • Reformatted prerequisites as a scannable bullet list
  • Sorted the Streams table alphabetically for consistency

Review guide

  1. docs/integrations/sources/incident-io.md — the only file changed

Key things to verify:

  • The streams table now has 15 rows (was 14) — escalations was added; confirm no streams were accidentally dropped during the alphabetical re-sort
  • The prerequisite instructions match the actual incident.io dashboard navigation

User Impact

Users see more accurate setup instructions and a complete list of available streams including the new escalations stream.

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

…lations stream

Co-Authored-By: bot_apk <apk@cognition.ai>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
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.
  • ❇️ 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.
  • 🚀 Connector Releases:
    • /publish-connectors-prerelease - Publishes pre-release connector builds (tagged as {version}-preview.{git-sha}) for all modified connectors in the PR.
    • /bump-progressive-rollout-version - Bumps connector version with an RC suffix (2.16.10-rc.1) for progressive rollouts (enableProgressiveRollout: true).
      • Example: /bump-progressive-rollout-version changelog="Add new feature for progressive rollout"
  • ☕️ 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
    • /bump-bulk-cdk-version bump=patch changelog='foo' - Bump the Bulk CDK's version. bump can be major/minor/patch.
  • 🐍 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.

@@ -34,19 +33,20 @@ The source connector supports the following [sync modes](https://docs.airbyte.co
| Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint-fix] reported by reviewdog 🐶

Suggested change
| Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental |
| Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental |

@github-actions
Copy link
Contributor

Deploy preview for airbyte-docs ready!

✅ Preview
https://airbyte-docs-x7ihii7rt-airbyte-growth.vercel.app

Built with commit 2aef3c4.
This pull request is being automatically deployed with vercel-action

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Improvements or additions to documentation team/documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants