## What
Regenerates platform documentation version 2.0 from the latest Next
(unreleased) version. This publishes all recent documentation updates
that have been made to the Next version as the stable 2.0 release.
Requested by Ian Alton (@ian-at-airbyte) via Slack thread:
https://airbytehq-team.slack.com/archives/D08FX8EC9L0/p1760747793195139?thread_ts=1760747793.195139
Link to Devin session:
https://app.devin.ai/sessions/edbc303b017445de9731080a55c04586
## How
1. Deleted the existing `version-2.0` directory from
`platform_versioned_docs/`
2. Deleted the `version-2.0-sidebars.json` from
`platform_versioned_sidebars/`
3. Temporarily removed `"2.0"` from `platform_versions.json`
4. Ran `pnpm docusaurus docs:version:platform 2.0` to regenerate version
2.0 from the current Next version
5. Verified the build succeeds locally
## Review guide
1. **New content**:
`platform_versioned_docs/version-2.0/understanding-airbyte/cdc-best-practices.md`
- Comprehensive new CDC configuration best practices guide. Review for
technical accuracy.
2. **Sidebar changes**:
`platform_versioned_sidebars/version-2.0-sidebars.json` - CDC content
reorganized under "Sync Modes" section. Verify navigation makes sense.
3. **Terminology updates** throughout various files:
- "Airbyte Open Source" → "Core"
- "Cloud Teams" → "Cloud Pro"
- "Self-Managed Community" → "Core"
- Verify these align with actual product naming conventions
4. **Content improvements** in access management, API documentation,
connector development, enterprise setup, and quickstart guides
## User Impact
Users viewing the version 2.0 platform documentation will see the latest
content updates, including:
- New comprehensive CDC best practices documentation
- Updated terminology reflecting current product names
- Improved clarity and accuracy throughout documentation
- Better organization of CDC-related content
No negative side effects expected - this is a documentation-only update.
## Can this PR be safely reverted and rolled back?
- [x] YES 💚
This is a documentation change only. Reverting would restore the
previous version 2.0 documentation content.
---------
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
## What
Created CDC best practices guide.
## How
- Created a dedicated CDC sidebar and moved it under `Moving and
Managing Data → Connections and Streams → Sync Modes.`
- Added the new documentation file to both `v1.8` and the new platform
version.
- Updated the sidebar configuration (sidebar.js) to include the new
guide.
## Review guide
Preview:
<img width="346" height="485" alt="Screenshot 2025-10-14 at 9 51 25 AM"
src="https://github.com/user-attachments/assets/46706717-a85a-4c99-af3c-530fa7793fa3"
/>
## User Impact
None
## Can this PR be safely reverted and rolled back?
<!--
* If unsure, leave it blank.
-->
- [ ] YES 💚
- [ ] NO ❌
---------
Co-authored-by: ian-at-airbyte <ian.alton@airbyte.io>
## What
Adds automation for syncing evergreen documentation to versioned docs,
and applies it to update version-2.0 docs. Follow-up to #68098 which
reorganized breaking changes documentation.
Requested by @aaronsteers in
https://app.devin.ai/sessions/644caae698024ce99ebb5a34609b785c.
## How
**New Poe Task** (`poe-tasks/repo-root-tasks.toml`):
- Created `poe docs-update-latest-evergreen` task
- Reads latest version from `platform_versions.json` (currently 2.0)
- For each specified directory (`connector-development/`,
`contributing-to-airbyte/`):
- Removes old versioned directory content with `rm -rf`
- Copies fresh content from main docs
- This ensures versioned docs are fully replaced (no stale files remain)
**Version-2.0 Docs Updates**:
- Applied task to sync latest connector development and contribution
guides
- This brought in changes from #68098 including the new
`connector-breaking-changes.md`
- Removed obsolete files that no longer exist in main docs:
- `contributing-to-airbyte/change-cdk-connector.md` (replaced by
connector-breaking-changes.md)
- `contributing-to-airbyte/submit-new-connector.md` (moved to
connector-development/)
## Review Guide
**🔴 CRITICAL - Destructive Operation:**
1. `poe-tasks/repo-root-tasks.toml` (lines 39-57)
- **Review the `rm -rf "$DEST"` approach**: This completely removes
directory contents before copying
- **Verify directory scope is appropriate**: Only
`connector-development/` and `contributing-to-airbyte/` are affected
- **Question: Are these directories truly 100% evergreen?** No
version-specific content should exist in these paths
**🟡 IMPORTANT - File Organization:**
2. Deleted files:
- `contributing-to-airbyte/change-cdk-connector.md` - Verify no incoming
links are broken
- `contributing-to-airbyte/submit-new-connector.md` - Now in
`connector-development/`
3. Link updates:
- `connector-development/README.md` - Updated submit-new-connector link
- `contributing-to-airbyte/README.md` - Updated connector guide
references
- `contributing-to-airbyte/developing-locally.md` - Updated
submit-new-connector link
- Verify all relative paths are correct from new locations
**🟢 MINOR - Documentation Content:**
4. `connector-development/connector-breaking-changes.md` - New
comprehensive guide (from #68098)
5. `connector-development/local-connector-development.md` - Added
breaking changes reference
## User Impact
**Positive:**
- Version-2.0 docs now include updated breaking changes guidance from
#68098
- Automated task reduces manual effort for future doc syncs
- Contributors viewing versioned docs get accurate connector development
information
**Potential Issues:**
- Task must be run manually after main docs updates (no automated
trigger)
- If any version-specific content exists in synced directories, it will
be incorrectly overwritten
- The `rm -rf` approach is aggressive - any mistake in directory paths
could be destructive
## Can this PR be safely reverted and rolled back?
- [x] YES 💚
Pure documentation changes. Reverting removes the Poe task and reverts
versioned docs to previous state. Main (latest) docs are unaffected.
---------
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
## What
Generates version 2.0 of the Airbyte platform documentation using
Docusaurus's built-in versioning system. This creates a frozen snapshot
of the current documentation that users can reference.
Requested by ian.alton@airbyte.io via [Slack
thread](https://airbytehq-team.slack.com/archives/D08FX8EC9L0/p1760490197805979?thread_ts=1760490197.805979).
Link to Devin run:
https://app.devin.ai/sessions/689693593bac44f4903f476aa17b872e
## How
- Ran `pnpm run docusaurus docs:version:platform 2.0` in the docusaurus
directory
- This automatically:
- Created `platform_versioned_docs/version-2.0/` containing a snapshot
of all current platform docs
- Created `platform_versioned_sidebars/version-2.0-sidebars.json` with
the sidebar navigation structure
- Updated `platform_versions.json` to add "2.0" to the version list
- Ran prettier to format the JSON files
- Verified the documentation builds successfully locally (build
completed in ~3 minutes with only pre-existing broken anchor warnings)
## Review guide
1. **Verify timing**: Confirm this is the correct time to release
version 2.0 of the documentation
2. **Version order**: Check `docusaurus/platform_versions.json` - verify
"2.0" is first in the array (newest version first)
3. **Build verification**: Ensure CI/Vercel builds pass without errors
4. **Spot check**: Optionally review 2-3 files in
`docusaurus/platform_versioned_docs/version-2.0/` to ensure content
looks reasonable
Note: This is a standard Docusaurus versioning operation that creates a
frozen snapshot of the current "next" documentation. The generated files
are extensive (500+ files) but follow Docusaurus conventions.
## User Impact
Users will see version 2.0 available in the version dropdown on
docs.airbyte.com. This provides a stable reference point for platform
documentation at this point in time. Existing versions (1.6, 1.7, 1.8)
remain unchanged.
## Can this PR be safely reverted and rolled back?
- [x] YES 💚
This is an additive change that doesn't modify existing versioned docs.
Reverting would simply remove version 2.0 from the version list and
delete the associated documentation files.
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
## What
The OpenTelemetry docs were unclear on how to actually configure the
Collector and Airbyte to connect, as well as necessary prereqs to do so.
This PR just updates to make those a little clearer.
## How
Docs updates.
## Review guide
Validate docs makes sense.
## User Impact
n/a
## Can this PR be safely reverted and rolled back?
<!--
* If unsure, leave it blank.
-->
- [x] YES 💚
- [ ] NO ❌
---------
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
## What
Consolidates the Vale linting job from PR #65973 into the existing
Reviewdog workflow. This adds Vale as a second documentation linting job
alongside MarkdownLint, both using the same reviewdog reporter for
consistency.
Related to #65973
## How
**Workflow Changes** (`.github/workflows/reviewdog.yml`):
- Updated workflow comments to reflect that both MarkdownLint and Vale
run on docs
- Added a new `vale` job that runs after the `markdownlint` job
- Configured Vale to use `github-pr-review` reporter (matching
MarkdownLint's configuration)
- Uses `filter_mode: added` to only lint newly added content
- Uses `fail_on_error: false` to keep Vale checks non-blocking
**Vale Configuration Changes** (`docusaurus/vale.ini`):
- Changed `MinAlertLevel` from `suggestion` to `warning`
- This scopes Vale to only report warnings and errors, excluding
suggestions
## Review guide
1. **`.github/workflows/reviewdog.yml`** - Review the Vale job
configuration:
- Verify the `errata-ai/vale-action` parameters are correct
- Confirm `github-pr-review` is the appropriate reporter (changed from
`github-pr-check` in the original PR #65973)
- Check that `filter_mode: added` and `fail_on_error: false` are the
desired settings
2. **`docusaurus/vale.ini`** - Review the MinAlertLevel change:
- Confirm `MinAlertLevel = warning` is the desired behavior (excludes
suggestions, only shows warnings and errors)
- Note: The `airbyte.punctuation = NO` rule was already removed in
master, so no changes needed there
## User Impact
**Positive:**
- Documentation PRs will now receive automated Vale linting feedback
alongside MarkdownLint
- Both linters use the same reporter type for consistent PR annotations
- Vale will only flag warnings and errors, reducing noise from
suggestions
**Neutral:**
- This supersedes the separate Vale workflow from PR #65973, which can
be closed once this is merged
- No impact to existing MarkdownLint checks
## Can this PR be safely reverted and rolled back?
- [x] YES 💚
This only adds a new linting job to the Reviewdog workflow. Reverting
would simply remove the Vale checks without affecting the existing
MarkdownLint job or any other workflows.
---
**Session Details:**
- Requested by: Ian Alton (ian.alton@airbyte.io)
- Link to Devin run:
https://app.devin.ai/sessions/7993d1cba2464b48bbababe88bda0671
---------
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
Limits doc is incorrect as Standard customers have access to 1
workspace.
---------
Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
## What
Trial lengths were recently updated to 30 days from 14 days, so updating
docs to reflect this. I can't seem to find any other references to that
length in the docs, so this should be the only other references.
## How
Updated docs.
## User Impact
Just minor docs update.
## Can this PR be safely reverted and rolled back?
<!--
* If unsure, leave it blank.
-->
- [x] YES 💚
- [ ] NO ❌
---------
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
