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

Enterprise Connector Docs #42564

Merged
merged 7 commits into from
Jul 30, 2024
Merged

Enterprise Connector Docs #42564

merged 7 commits into from
Jul 30, 2024

Conversation

evantahler
Copy link
Contributor

@evantahler evantahler commented Jul 26, 2024

This PR mocks up adding enterprise connector docs to docs.airbyte.com

Screenshot 2024-07-26 at 9 31 14 AM

Problems

  • The docs for enterprise connectors live in the other repo airbytehq/airbyte-enterprise, along with the code for the connector
  • Enterprise connectors, so far, are not in the registry. That breaks a number of badging, usage, etc tools we have on our connector docs today. It also means if we use the normal connector docs tooling, enterprise connectors will look achived.
  • We have community connectors that talk to the same databases. We want to disambiguate that the enterprise connector and the community connector both exist, and are different.

Design Choices

  • A new path for enterprise connectors: /integrations/enterprise-connectors/
  • All Enterprise Connector are also certified
  • A custom remark plugin for the header of the enterprise docs pages to make things work the way we want

Future work

  • The docs from the private airbytehq/airbyte-enterprise repo should be automatically copied over to the right place in this repo at the time of publish. For now, that will be a manual process. Changes to the docs will need to be manually kept in-sync until that is complete
  • This update does not make the connector docs appear in product when setting up the connector (there are no custom connector docs at this time)
  • Connector Icons

@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Jul 26, 2024
Copy link

vercel bot commented Jul 26, 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 Jul 30, 2024 4:24pm

@evantahler evantahler marked this pull request as ready for review July 29, 2024 16:14
@evantahler evantahler enabled auto-merge (squash) July 30, 2024 16:20
@evantahler evantahler merged commit be5e974 into master Jul 30, 2024
29 checks passed
@evantahler evantahler deleted the evan/enterprise-docs branch July 30, 2024 16:24
BenGalewsky pushed a commit to BenGalewsky/airbyte that referenced this pull request Aug 4, 2024
Co-authored-by: Alexandre Cuoci <alex.cuoci@airbyte.io>
jtruty pushed a commit to jtruty/airbyte that referenced this pull request Aug 10, 2024
Co-authored-by: Alexandre Cuoci <alex.cuoci@airbyte.io>
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.

4 participants