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: remove redundant content from connector's READMEs (discussing, do not merge) #52698

Draft
wants to merge 5 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 Jan 31, 2025

This PR removes redundant content from connector-level READMEs and adds links to authoritative documentation.

Changes:

  • Removed redundant development and publishing instructions from source-linkedin-pages and source-freshchat
  • Added links to authoritative documentation sources
  • Preserved connector-specific information
  • Fixed broken Connector Builder UI documentation link
  • Updated source-the-guardian-api README to use standard documentation structure
  • Updated destination-mysql-strict-encrypt README with proper documentation links

Link to Devin run: https://app.devin.ai/sessions/61a22ee817e44978b6323f4963f54bf5

…freshchat READMEs

- Remove duplicated development and publishing instructions
- Add links to authoritative documentation sources
- Keep connector-specific information intact
- Maintain consistent documentation structure

Co-Authored-By: Aaron <AJ> Steers <[email protected]>
Copy link

vercel bot commented Jan 31, 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 Feb 1, 2025 0:55am

Copy link
Contributor Author

🤖 Devin AI Engineer

Original prompt from Aaron:

Devin, there's a lot of redundant and stale documentation our connector-level README.md files. We should delete stale/redundant info that isn't specific to the connector(s) and we should link to other othoritative guides for contributing to cnnectors, debugging, etc.

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

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Copy link
Contributor

@ian-at-airbyte ian-at-airbyte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the consolidation here and the consistency from one readme to the next. I'll assume we've already verified the it was indeed correct to remove the existing content. If that's the case, this looks good.

@aaronsteers
Copy link
Collaborator

aaronsteers commented Feb 1, 2025

@ian-at-airbyte - thanks for the review! I can't say if all the removed content is stale or not but I can look into this further.

And to be clear, there's no rush to merge this; I'd just like to work towards a place where there's a single place to update connector maintenance and "contributing" guides for each language / type.

@ian-at-airbyte
Copy link
Contributor

Got it. That makes sense. I do like the AI content participation as a whole but to borrow the Russian proverb, we might want to adopt a "Trust, but verify" philosophy, at least for now.

@aaronsteers aaronsteers changed the title docs: remove redundant content from source-linkedin-pages and source-freshchat READMEs docs: remove redundant content from connector's READMEs (trial, do not merge) Feb 1, 2025
@aaronsteers aaronsteers marked this pull request as draft February 1, 2025 01:29
@aaronsteers aaronsteers changed the title docs: remove redundant content from connector's READMEs (trial, do not merge) docs: remove redundant content from connector's READMEs (testing, do not merge) Feb 1, 2025
@aaronsteers aaronsteers changed the title docs: remove redundant content from connector's READMEs (testing, do not merge) docs: remove redundant content from connector's READMEs (discussing, do not merge) Feb 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants