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: Enable ERDs for 10 top sources. #45085

Merged
merged 4 commits into from
Sep 9, 2024

Conversation

letiescanciano
Copy link
Contributor

@letiescanciano letiescanciano commented Sep 2, 2024

Closes https://github.com/airbytehq/airbyte-internal-issues/issues/9174

What

  • Introduce a new custom component <ErdDiagram/> which can be added to each connector once a ERD has been generated for that connector using dbdocs.
  • Add ERDs for top 10 sources
Screenshot 2024-09-02 at 16 05 46

How

  • ERD url can be access at the connector registry.
  • The new component will retrieve that information and add it as a link to the connector docs.

User Impact

Users will now be able to check ERD diagrams for some sources.

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

Copy link

vercel bot commented Sep 2, 2024

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 Sep 5, 2024 5:37pm

Copy link
Contributor

@teallarson teallarson left a comment

Choose a reason for hiding this comment

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

Changes lgtm!

I think we should have a hover state on the image in addition to the cursor change, but (a) I don't see designs for that and (b) I also see a handful of places in the docs that don't have a hover state, so not a blocking comment!

@letiescanciano letiescanciano enabled auto-merge (squash) September 4, 2024 14:50
@letiescanciano letiescanciano enabled auto-merge (squash) September 4, 2024 15:07
Copy link
Contributor

@alafanechere alafanechere left a comment

Choose a reason for hiding this comment

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

Changes LGTM. I'll force merge this given that:

  • No connector code was changed
  • CI failures are not on QA checks (which is the only test suite validating the docs)
  • CAT failures also exist on master.

@alafanechere
Copy link
Contributor

/approve-and-merge reason="CI failures unrelated to the code change."

@octavia-approvington
Copy link
Contributor

You did it!
finish line

@octavia-approvington octavia-approvington merged commit f216a60 into master Sep 9, 2024
37 of 43 checks passed
@octavia-approvington octavia-approvington deleted the leti/enable-sources-erds branch September 9, 2024 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants