1
0
mirror of synced 2025-12-19 18:14:56 -05:00

27 Commits

Author SHA1 Message Date
Ian Alton
e57ab8cb0c docs(ai-agents): Add AI connector tutorials and Agent engine positioning (#70461)
Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Alexandre Girard <alexandre@airbyte.io>
2025-12-12 16:24:55 -08:00
devin-ai-integration[bot]
1c542abd0c docs(destination-clickhouse): Improve documentation with context and present tense (#69223)
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: Edward Gao <edward.gao@airbyte.io>
2025-11-13 01:01:45 +00:00
devin-ai-integration[bot]
a605a81da9 docs: Create community docs instance and move community content (#68675)
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>
2025-11-03 18:22:15 -08:00
Vai Ignatavicius
8e1e7ee22b docs: Fix spelling (#68603) and add NetSuite to vocabulary acceptance list
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-10-24 10:44:08 +01:00
Ian Alton
4f97ee2dab docs: update plan names in docs content (#67573)
## 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>
2025-10-17 17:34:29 -07:00
Yarden Carmeli
84ac62f012 docs: add CDC Best Practices guide (#68086)
## 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>
2025-10-16 10:58:58 -07:00
Ian Alton
0aa1802cae Airbyte 2.0 release notes (#67003)
## What
<!--
* Describe what the change is solving. Link all GitHub issues related to
this change.
-->

Release notes for Airbyte 2.0.

Also:

- Added new terminology to linting allowlist for Vale.
- Added a React component so we can embed YouTube videos.

## 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 
2025-10-14 18:14:41 -07:00
Teal Larson
b50994c6f3 docs: Add comprehensive Sonar Embedded API documentation (#67580)
## Overview

This PR addresses critical documentation drift between the Sonar
implementation and the Airbyte documentation repository. Based on a
comprehensive drift analysis performed on 2025-10-08, this update adds
missing API documentation for HIGH PRIORITY features that are fully
implemented in Sonar but completely undocumented.

Reference: docs-drift-analysis-2025-10-08.md (in sonar repo)

## Changes Summary

### New Documentation Files (3)

1. **workspaces.md** - Workspace Management API
   - List workspaces with cursor-based pagination
   - Get, update, and delete workspaces
   - Workspace statistics and sync operations
   - Complete pagination guide and filtering examples

2. **authentication.md** - Complete Authentication Guide
   - All three token types (Operator Bearer, Scoped, Widget)
   - Region selection (US/EU)
   - Template filtering via tags during token generation
   - Token lifecycle management and security best practices
   - 20+ code examples

3. **tags.md** - Template Tag Management
   - Tag CRUD operations
   - Tag selection modes (ANY vs ALL)
   - Tagging source and connection templates
   - Tier-based access control examples

### Updated Documentation Files (3)

4. **source-templates.md** - Enhanced with stream management, PATCH
endpoint, tag operations, source definition catalogs

5. **connection-templates.md** - Added sync_on_create,
non_breaking_changes_preference, cron validation, PATCH endpoint, tag
operations

6. **configuring-sources.md** - Added region selection, stream
management, JMESPath querying, JSON Patch operations

## Impact

- 25+ previously undocumented API endpoints now documented
- ~2,500 lines of documentation added
- 100+ code examples
- 12 HIGH PRIORITY documentation gaps addressed

## Validation

All documentation validated against:
- Sonar codebase at commit 350a75fe73
- FastAPI route definitions
- Pydantic schemas
- Existing documentation style

## Breaking Changes

None - Documentation only

---------

Co-authored-by: Alexandre Girard <alexandre@airbyte.io>
2025-10-13 12:41:54 -07:00
Ian Alton
877de826b0 chore: add admonitions to accept list (#67622)
## What
<!--
* Describe what the change is solving. Link all GitHub issues related to
this change.
-->

This PR adds Docusaurus admonitions to Vale's ignore list, so they're
never linted for style.

## 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 
2025-10-10 20:38:35 -04:00
devin-ai-integration[bot]
7b096d0d73 docs(platform): fix Vale linter violations in writing-docs.md (#66730)
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>
2025-09-27 13:14:13 -07:00
Ian Alton
93fb9f4567 Docs for new orgs and workspaces redesign aka Org Landing Page (#66550)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-09-25 13:52:43 -07:00
Ian Alton
1fbd26b697 Single node data plane documentation (#66176) 2025-09-12 09:47:06 -07:00
Matteo Palarchio
ea51a0e3dd Docs cloud enterprise (#65578)
Co-authored-by: ian-at-airbyte <ian.alton@airbyte.io>
Co-authored-by: Alexandre Cuoci <Hesperide@users.noreply.github.com>
2025-08-29 01:32:02 +00:00
Ian Alton
b0aa3ad51d Data activation documentation (#63765)
Co-authored-by: nourienf <nourien.fouad@airbyte.io>
2025-07-30 14:11:43 -07:00
Ian Alton
345f2b99b2 [DOCS] Helm chart 2.0 docs (#61577)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: perangel <perangel@gmail.com>
2025-07-16 21:59:34 -07:00
Ian Alton
3487dc7e3e Docs property chunking (#61433)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2025-06-10 20:58:48 +00:00
Ian Alton
15829b6267 Docs file syncing low code (#61437)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2025-06-10 20:43:40 +00:00
Quinton Wall
f01f60f05f Update use-embedded.md to new sample app (#61377)
Co-authored-by: ian-at-airbyte <ian.alton@airbyte.io>
2025-06-06 17:28:47 +00:00
Quinton Wall
1346afe908 Update prerequisites-setup.md (#61375)
Co-authored-by: ian-at-airbyte <ian.alton@airbyte.io>
2025-06-06 10:21:48 -07:00
Ian Alton
2a0ac62da2 Move Airbyte Embedded docs to their own instance (#60340) 2025-05-20 14:48:58 -07:00
Ian Alton
04ac7b9001 Quickstart clarifications based on feedback (#54712) 2025-04-29 01:26:58 +00:00
Ian Alton
6cb51ea631 1.6 release notes plus service account upgrade (#56423) 2025-04-11 19:40:43 +00:00
Ian Alton
cd6a30d4da Update connection timeline info, recompose the topic a bit, and lint it. (#56438) 2025-04-02 16:46:01 -07:00
Ian Alton
1e8fdb6b8d Add MarkDownLint configuration and instructions (#56378) 2025-03-26 16:35:43 -07:00
Ian Alton
e2ea32ec4e 11526 second pass through iceberg documentation (#55736) 2025-03-13 16:02:26 -07:00
Ian Alton
ec751f3b36 Update OTEL metrics, add new linting exceptions (#55752) 2025-03-13 14:47:20 -07:00
Ian Alton
4018cf9460 Implement Vale to lint the docs (#54732) 2025-03-03 13:10:33 -08:00