1
0
mirror of synced 2025-12-21 19:11:14 -05:00
Commit Graph

496 Commits

Author SHA1 Message Date
devin-ai-integration[bot]
27ed20403e chore(workflows): Consolidate Vale linting into Reviewdog workflow (#67620)
## 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>
2025-10-10 23:01:49 +00:00
devin-ai-integration[bot]
2360fe0502 docs: add helm v2 unified ingress configuration documentation (#67577)
## 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>
2025-10-09 13:24:17 -07:00
Alexandre Cuoci
fe999527ae Update understand-airbyte-cloud-limits.md (#67576)
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>
2025-10-08 23:04:55 +00:00
devin-ai-integration[bot]
a8ef566ba3 chore(docs): Remove redundant static llms.txt file (#67572)
## What

Removes the redundant static `llms.txt` file from the Docusaurus static
directory. This file is no longer needed because the
`@signalwire/docusaurus-plugin-llms-txt` plugin automatically generates
the same content during the build process.

Requested by Ian Alton (ian.alton@airbyte.io) via Slack.

Link to Devin run:
https://app.devin.ai/sessions/7bfbeb068874484ca7987f541a0b89eb

## How

- Deleted `docusaurus/static/llms.txt` (100 lines of documentation
links)
- The `@signalwire/docusaurus-plugin-llms-txt` plugin configured in
`docusaurus.config.js` generates equivalent content at build time

## Review guide

1. Verify that `@signalwire/docusaurus-plugin-llms-txt` plugin is
properly configured in `docusaurus/docusaurus.config.js` (lines 207-218)
2. Confirm that the build process successfully generates
`build/llms.txt` during documentation builds
3. Check that no external systems or links specifically reference
`/static/llms.txt` path

## User Impact

- No user-facing impact - the `llms.txt` file will still be available at
the same URL path after build
- Content will now be automatically generated based on the actual
documentation structure rather than manually maintained
- Reduces maintenance burden by eliminating duplicate/redundant file

## Can this PR be safely reverted and rolled back?

- [x] YES 💚

This change only removes a redundant file. If the plugin fails to work
as expected, the static file can be easily restored from git history.

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-10-08 14:09:46 -07:00
Lucas Leadbetter
9ab8811fc0 updating trial length docs per recent changes (#67513)
## 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>
2025-10-08 07:46:16 -07:00
Vai Ignatavicius
ebbf6b1751 Fixed typo in heartbeats docs (#67013) 2025-10-02 19:03:57 +01:00
devin-ai-integration[bot]
63a3e5c39d docs(platform): Set Azure infrastructure page as draft (#66745)
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-29 11:40:57 -07:00
Ian Alton
e70507fbfb Remove references to webapp in the docs (#64540)
Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2025-09-27 14:12:44 -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
devin-ai-integration[bot]
7fa72047cd feat(docs): Implement variable interpolation using markdown preprocessor (#66577)
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-23 10:07:23 -07:00
devin-ai-integration[bot]
5f9c5e92a3 docs: Add Keycloak ingress configuration for Self-Managed Enterprise (#66488)
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: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-09-22 10:54:49 -07:00
devin-ai-integration[bot]
6ce6038dd9 docs: Update product plan display names (#66548)
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: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-09-19 19:07:19 -07:00
Ian Alton
df4febc271 Add notes that support must enter SSO config info (#66235) 2025-09-17 09:55:17 -07:00
Lucas Leadbetter
9de8863670 update generic-oidc key to genericOidc (#66232) 2025-09-15 09:35:59 -07:00
devin-ai-integration[bot]
574ae045cb feat(docs): move enterprise-connector attribute from header div to H1 element (#66222)
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-12 13:44:38 -07:00
devin-ai-integration[bot]
67891c9fb2 feat(docs): add enterprise-connector attribute to enterprise connector docs for Algolia indexing (#66218)
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-12 12:50:18 -07:00
Ian Alton
1fbd26b697 Single node data plane documentation (#66176) 2025-09-12 09:47:06 -07:00
Jose Pefaur
10b26b4c4d docs: rename source netsuite enterprise docs (#65998) 2025-09-08 11:44:47 -05:00
Jose Pefaur
8172dfd439 ci: misc changes to enable support for enterprise connectors (#65942) 2025-09-05 08:20:43 -05:00
Ian Alton
63d19d530f Docs rejected records plans (#65923) 2025-09-04 17:25:01 -07:00
Ian Alton
b58c916f82 Docs extra scopes in OIDC (#65930) 2025-09-03 15:29:27 -07:00
Ian Alton
7244a435e9 Auth should not be set to false when SSO is enabled. (#65907) 2025-09-02 16:12:28 -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
Teo
f31a6d18b3 Update README.md (#65146)
Co-authored-by: Alexandre Girard <alexandre@airbyte.io>
2025-08-22 08:20:23 -07:00
Ian Alton
639cadf8de Update early access info banner (#65140) 2025-08-21 17:57:48 -07:00
Ian Alton
0ad41616e9 Docs search console verification (#65123) 2025-08-21 09:21:54 -07:00
Ian Alton
c8cf650229 Added a single source of truth for keypair authentication in Snowflake (#63726)
Co-authored-by: Conall Ó Gribín <167999304+Conall-airbyte@users.noreply.github.com>
2025-08-20 08:06:49 -07:00
Ian Alton
66b0e7ff15 docs: update version-related banners and dropdowns (#64573) 2025-08-19 11:02:02 -07:00
Aaron ("AJ") Steers
a2b78a54f9 docs: improve AIRBYTE_ENTRYPOINT requirements with absolute path guidance (#64943)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2025-08-15 22:26:26 -07:00
devin-ai-integration[bot]
7c204777e4 docs(platform): Generate version 1.8 platform documentation (#64948)
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-08-15 13:27:39 -07:00
Ian Alton
50115a19d8 1.8 release notes (#64145) 2025-08-14 10:32:41 -07:00
Prabhat Agarwal
ab11d924b1 Update low-code-cdk-overview.md (#64876) 2025-08-14 08:53:57 -07:00
Ian Alton
297ee3aaaa Docs for speed in 1.8 (#64535) 2025-08-08 14:20:57 -07:00
Ian Alton
401911eaa8 Docs connector builder schema second pass (#64165)
Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2025-08-06 16:35:04 -07:00
devin-ai-integration[bot]
4d217de506 fix(docs): prevent enterprise connectors from appearing in Airbyte Connectors tab (#64488)
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-08-04 11:30:52 -07: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
6afd79c203 Remove IDs from H1s in connector documentation (#63782)
Co-authored-by: letiescanciano <leticia.escanciano@gmail.com>
2025-07-28 15:56:38 -07:00
Alexandre Girard
aa219223f7 feat: add docs for embedded apis (#64094)
Updating new docs.
2025-07-28 09:07:57 -07:00
Yarden Carmeli
18cd563eae v1.7 - Improve CDC documentation for adding new schemas/columns (#63734)
Co-authored-by: ian-at-airbyte <ian.alton@airbyte.io>
2025-07-24 05:25:16 -07:00
Charles
50a97db804 chore: migrate connectors from MIT to ELv2 (#63723) 2025-07-22 14:26:58 -07:00
Matteo Palarchio
9c4df077cf Update cdc.md (#63722) 2025-07-22 14:16:01 -07:00
Ryan Br...
05cb813aca Update docs to mention clickhouse namespace -> database mapping (#62950) 2025-07-22 11:39:23 -07:00
Ian Alton
ba53815236 Improve table display (#63362) 2025-07-17 16:40:32 -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
letiescanciano
9ac847a68e docs: install openapi-specs-plugin (#62871) 2025-07-16 12:18:21 +02:00
devin-ai-integration[bot]
cca6dacb9d feat(docs): Add Cloud Enterprise product badge (#62945)
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-07-11 16:01:56 -07:00
Ian Alton
aa9638ae02 Docs handle ingress change (#62940) 2025-07-11 11:34:47 -07:00
Ian Alton
cbd2253006 docs: 1.7 ingress review (#62511) 2025-07-07 13:06:55 -07:00
Quinton Wall
d92736c272 added mcp and cleaned up navigation (#62490) 2025-07-07 12:09:10 -07:00
Ian Alton
4247a2a102 Move OTEL metrics information to its own page (#56928) 2025-07-03 15:24:12 -07:00