Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(understanding-airbyte): Add file sync and permission sync documentation (do not merge) #55783

Draft
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

devin-ai-integration[bot]
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Mar 15, 2025

This PR adds documentation for two Airbyte capabilities:

  1. Airbyte File Sync - Explains how to transfer raw files between systems without parsing their contents
  2. Airbyte Permission Sync - Describes the capability to maintain access controls when transferring data
  3. Airbyte Unstructured Parsing - Describes how to parse document files into markdown.

Both pages include:

  • Overview of the capability
  • How it works
  • Supported connectors
  • Usage instructions
  • Limitations
  • Technical implementation details
  • Future enhancements

The PR also adds vanity URL redirects for easier discovery.

Link to Devin run: https://app.devin.ai/sessions/620a617ffafc441391b9d0373365a384
Requested by: @aaronsteers

Copy link

vercel bot commented Mar 15, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
airbyte-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 15, 2025 6:26pm

Copy link
Contributor Author

🤖 Devin AI Engineer

Original prompt from Aaron:

@Devin - Please look for a documentation page about file transfer capabilities in the main airbyte repo. I don't believe we have one yet. If not, we're going to create one.

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add "(aside)" to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@ian-at-airbyte
Copy link
Contributor

(aside) @aaronsteers we actually already have a place for this information, and file transfers are covered: https://docs.airbyte.com/using-airbyte/delivery-methods

Rather than creating new pages, I think we should repurpose/merge and add the access control info.

@aldogonzalez8
Copy link
Contributor

aldogonzalez8 commented Mar 20, 2025

(aside) @aaronsteers we actually already have a place for this information, and file transfers are covered: https://docs.airbyte.com/using-airbyte/delivery-methods

Rather than creating new pages, I think we should repurpose/merge and add the access control info.

nit: I would suggest to convert Delivery Methods to an accordion menu/Collapsible Section with new pages for:

  • Replicate records.
    1. Airbyte Structured Parsing
    2. Airbyte Unstructured Parsing
  • Airbyte File Sync/Copy raw files
  • Airbyte Permission Sync

I feel it gives some consistency. I'm excited about seeing what the docs update is!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants