1
0
mirror of synced 2025-12-19 18:14:56 -05:00
Files
airbyte/docusaurus
Aaron ("AJ") Steers 1813b3de31 Add docs-evergreen-copy Poe task and sync versioned docs (#68111)
## 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>
2025-10-15 16:10:02 -07:00
..
2025-10-14 18:14:41 -07:00

Documentation and Docusaurus

For instructions, visit Contribute to Documentation.