## What
<!--
* Describe what the change is solving. Link all GitHub issues related to
this change.
-->
This pull request updates plan names across most of the Documentation so
they're consistent with our current plan names.
## How
<!--
* Describe how code changes achieve the solution.
-->
My original plan was to convert free text to MDX variables so we only
had to make future updates to names in one place. While broadly
successful, there were numerous edge cases that made rolling this out
almost impossible. There were too many ways and places you couldn't use
variables due to a variety of limitations in Docusaurus and Airbyte's
internal MarkDown processor. Explaining how to properly use them made me
realize how prohibitively insufficient this was. In the end, I opted to
return to using free text for plan names.
Scope is now broadly reduced. This PR:
- Converts remaining instances of old plan names to new plan names. In
most cases, I replaced old plan names with new plan names directly. In
some cases, sentences were rewritten to make a bit more sense or be more
maintainable in the future.
- Removes previously added preprocessor variables from Docusaurus
configuration.
- Update Vale styles or various artifacts of content based on linter
findings.
## Review guide
<!--
1. `x.py`
2. `y.py`
-->
Spot check updated pages to ensure plan names appear appropriately. It's
probably not necessary to check every single instance in detail.
For Platform docs, changes only apply to the Next/Cloud version. After
merging, I'll regenerate 2.0 docs based on this. 1.8 and before won't be
updated.
## User Impact
<!--
* What is the end result perceived by the user?
* If there are negative side effects, please list them.
-->
People can see correct plan names in docs content.
## 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
<!--
* Describe what the change is solving. Link all GitHub issues related to
this change.
-->
This small change addresses a complaint about the docs from a user who
did not know how to resolve the secure-cookies requirement when
deploying Airbyte using the Quickstart guide. The problem/resolution
should be a bit more clear now.
## How
<!--
* Describe how code changes achieve the solution.
-->
## Review guide
<!--
1. `x.py`
2. `y.py`
-->
## User Impact
<!--
* What is the end result perceived by the user?
* If there are negative side effects, please list them.
-->
## Can this PR be safely reverted and rolled back?
<!--
* If unsure, leave it blank.
-->
- [x] YES 💚
- [ ] NO ❌
## 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
Converts the Airbyte documentation home page from a static markdown page
to a dynamic React-based page with improved visual design and
navigation. Moves "Why Airbyte?" content from home page to platform
page.
Requested by ian.alton@airbyte.io in session:
https://app.devin.ai/sessions/6441f0af52ff4f0bb03a55c3fd4252c9
## How
**Architecture Change:**
- Disabled the default Docusaurus docs plugin at root route (`docs:
false`)
- Enabled pages plugin to support standalone React pages
- Deleted `/docs/home/readme.md` and `sidebar.js`
- Created new React component at `/docusaurus/src/pages/index.js`
**New Home Page Features:**
1. **Hero Section**: Purple background (adapts to dark mode) with title,
description, and Arcade demo embed
2. **Navigation Grid**: 6 cards with custom SVG icons:
- Platform → `/platform/`
- Connectors → `/integrations/`
- Release Notes → `/release_notes/`
- AI Agents → `/ai-agents/`
- Developers → `/platform/api-documentation`
- Community and Support → `/platform/community/getting-support`
3. Fully responsive design (3 columns → 2 columns → 1 column)
4. Fast hover transitions (0.2s ease-out)
5. Empty page title to use site-level title (avoids "Airbyte
Documentation | Airbyte Docs" duplication)
**Content Migration:**
- Moved "Why Airbyte?" section with badges from home page to
`/docs/platform/readme.md`
## Review guide
**Critical files (routing change):**
1. `docusaurus/docusaurus.config.js` - Verify the docs plugin disable
and pages plugin enable
2. `docusaurus/src/pages/index.js` - New home page React component,
check all navigation links
**Styling:**
3. `docusaurus/src/pages/index.module.css` - Check CSS variables are
defined:
- `--color-grey-40`
- `--color-blue-30`
- `--ifm-color-primary-lightest`
- Responsive breakpoints at 996px and 640px
**Content:**
4. `docs/platform/readme.md` - Verify "Why Airbyte?" section placement
makes sense here
5. Deleted files (`docs/home/readme.md`, `sidebar.js`) - Confirm no
other references exist
**Testing checklist:**
- [x] Navigate to `/` and verify new home page renders
- [x] Test all 6 navigation card links
- [x] Toggle dark/light mode
- [x] Test responsive design at tablet (996px) and mobile (640px)
breakpoints
- [x] Verify Arcade embed loads correctly
- [x] Check `/platform/` page has "Why Airbyte?" section
- [x] Verify page title doesn't show duplicate "Airbyte Documentation"
**Accessibility concerns:**
- SVG icons lack aria-labels - should be addressed in follow-up
## User Impact
Users will see a modernized home page with:
- Prominent hero section with purple Airbyte branding
- Clear navigation cards with icons and descriptions
- Improved mobile experience
- Faster hover interactions
**Potential negative impacts:**
- "Why Airbyte?" content moved from home to platform page - users
expecting it on home page won't find it there
- Old bookmarks to `/docs/home` may break (though likely redirected by
Docusaurus)
- Page title behavior changed (empty title uses site title)
## Can this PR be safely reverted and rolled back?
- [x] YES 💚
This is a pure UI change with no backend or data modifications. The old
markdown file can be restored from git history. All navigation links
point to existing routes.
---------
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
<!--
* Describe what the change is solving. Link all GitHub issues related to
this change.
-->
Updated the guide AJ produced for breaking connector changes. Adds
instructions to use the block of generic connector upgrade information
that can be added dynamically.
## How
<!--
* Describe how code changes achieve the solution.
-->
## Review guide
<!--
1. `x.py`
2. `y.py`
-->
## User Impact
<!--
* What is the end result perceived by the user?
* If there are negative side effects, please list them.
-->
## Can this PR be safely reverted and rolled back?
<!--
* If unsure, leave it blank.
-->
- [x] YES 💚
- [ ] NO ❌
---------
Co-authored-by: Patrick Nilan <nilan.patrick@gmail.com>
## 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>
## What
Updates Airbyte's ingress documentation to acknowledge that ingress
support exists in both Helm chart V1 and V2, while maintaining focus on
the recommended V2 approach. This addresses the discovery that PR #17752
added unified ingress support to Helm V1 charts, making previous "V2
only" statements inaccurate.
Related to on-call issue #9393 and feature PRs #17787 (V2 ingress) and
#17752 (V1 ingress).
## How
- **Removed "V2 only" language** from ingress documentation sections
- **Added notes for V1 users** directing them to the [values.yaml
reference](/platform/deploying-airbyte/values) page for V1-specific
ingress configuration structure
- **Maintained V2 as primary focus** with comprehensive configuration
examples and guidance
- **Updated helm chart comparison table** to show ingress availability
in both versions
- **Restructured documentation** to clearly separate "Helm chart
ingress" vs "manual ingress" options
- **Combined and simplified examples** to focus on required backend
services (server + connector-builder-server)
## Review guide
1. **docs/platform/deploying-airbyte/integrations/ingress.md** - Main
ingress documentation restructuring
- Verify the V1 note and values.yaml link accuracy
- Check that V2 examples are technically correct (backend field usage)
- Ensure the two-option structure (Helm chart vs manual) is clear
2. **docs/platform/enterprise-setup/implementation-guide.md** -
Enterprise ingress documentation
- Verify enterprise-specific configuration (keycloak backend)
- Check V1 reference note consistency with main docs
- Ensure switching instructions are clear
3. **docusaurus/static/_helm-chart-2-syntax-changes.md** - Helm
comparison table update
- Verify ingress entry accurately represents V1 vs V2 differences
- Check link to ingress documentation works
## User Impact
- **Helm V1 users** now have clear guidance that ingress is available
(previously told it was V2-only)
- **Helm V2 users** get improved, comprehensive ingress configuration
guidance
- **All users** benefit from clearer separation between Helm-managed vs
manual ingress approaches
- **Documentation accuracy** improved to reflect actual product
capabilities
## Can this PR be safely reverted and rolled back?
- [x] YES 💚
This is documentation-only changes with no code modifications. Revert
would restore previous "V2 only" statements but wouldn't break
functionality.
---
**Link to Devin run**:
https://app.devin.ai/sessions/5f4a71d6776d486aa4ec93eec89bd643
**Requested by**: ian.alton@airbyte.io
---------
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
<!--
* Describe what the change is solving. Link all GitHub issues related to
this change.
-->
This is minor docs cleanup after we released the Iowa region on GCP.
There's not much to update, but it did prompt me to take a look at a few
things, update some URLs, and reframe the discussion of how Airbyte is
deployed to Cloud.
Companion change to this UI update, but there is no dependency between
them. https://github.com/airbytehq/airbyte-platform-internal/pull/17923
## How
<!--
* Describe how code changes achieve the solution.
-->
## Review guide
<!--
1. `x.py`
2. `y.py`
-->
## User Impact
<!--
* What is the end result perceived by the user?
* If there are negative side effects, please list them.
-->
## 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>
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>
