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

Always show Reference section in connector docs #52143

Merged
merged 2 commits into from
Jan 24, 2025

Conversation

devin-ai-integration[bot]
Copy link
Contributor

What

  • Makes the Reference section always appear in connector documentation
  • Removes dependency on PyPI publishing status
  • Adds fallback message when connector lacks valid spec: "No configuration specification is available for this connector."

Why

Previously, Reference sections were only shown for PyPI-enabled connectors. However, all connectors should have this section to document their configuration, regardless of their implementation language or publishing status.

How

  • Modified specDecoration.js to remove PyPI check
  • Added fallback text for connectors without valid specs
  • Simplified the logic to always try rendering the Reference section

Testing

The changes will be validated through CI documentation builds.

Link to Devin run: https://app.devin.ai/sessions/175f32015b2d4001b891b96d353c8996

Copy link

vercel bot commented Jan 24, 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 Jan 24, 2025 10:58pm

Copy link
Contributor Author

Original prompt:

@Devin - Our connector docs in the airbytehq/airbyte repo (aka "the monorepo") auto-add a "Reference" section to most sources. However, we don't have this section for destinations and I'd like to fix this. The 'Reference' section tells people the programmatic config inputs they'll need to use when working with the connector in PyAirbyte, Teraform, or the REST API. In theory, we should include this section for all connectors, if possible.

Copy link
Contributor Author

🤖 Devin AI Engineer

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

@CLAassistant
Copy link

CLAassistant commented Jan 24, 2025

CLA assistant check
All committers have signed the CLA.

@evantahler
Copy link
Contributor

I checked out the vercel preview and things look good to me! I checked API and Java sources and destinations. This is a markdown AST change, so it does its thing at build time (not in the user's browser), so if it compiled OK, it's likely rather safe.

@aaronsteers aaronsteers merged commit 8c6b76a into master Jan 24, 2025
24 of 25 checks passed
@aaronsteers aaronsteers deleted the devin/1737754931-always-on-reference branch January 24, 2025 23:09
@aaronsteers
Copy link
Collaborator

Post-merge, I had Devin do a review of a random set of 25 sources and ~40 destinations. Everything is looking good!

The Cassandra and Pulsar connectors are getting the "else" treatment - which looks valid. And root cause in those cases seems to be that the connector is archived, which makes sense why we might not have config metadata for them.

Example:
https://docs.airbyte.com/integrations/destinations/cassandra

image

btkcodedev pushed a commit that referenced this pull request Feb 3, 2025
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: Aaron <AJ> Steers <[email protected]>
stephane-airbyte pushed a commit that referenced this pull request Feb 4, 2025
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: Aaron <AJ> Steers <[email protected]>
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.

4 participants