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

chore: add docs for custom components #55777

Merged
merged 1 commit into from
Mar 16, 2025
Merged

Conversation

bnchrch
Copy link
Contributor

@bnchrch bnchrch commented Mar 14, 2025

What

  • Adds documentation for a new custom component feature.
  • Feature is available only to OSS and enterprise users.
  • Documentation includes:
    • Optional to run information.
    • Unsafe feature warnings.
    • Instructions on how to enable the feature.

How

  • Updated the existing documentation to incorporate the new feature.
  • Clearly outlined optional and unsafe aspects.
  • Provided step-by-step instructions for enabling the feature.

Additional Context

  • This documentation aims to clarify the use of the custom component.
  • It ensures users are aware of the potential risks.

Notes for Reviewer

  • Please check for clarity in the documentation.
  • Ensure that all steps for enabling the feature are accurately described.
  • Verify that warnings regarding safety are prominent and easy to understand.

Recommended Reading Order

  • Documentation Overview
  • New Custom Component Feature
  • Optional and Unsafe Features
  • Enabling Instructions

Can This PR Be Reverted and Rolled Back

  • Yes, this PR can be easily reverted if needed, as it only involves documentation updates.

Related to https://github.com/airbytehq/airbyte-platform-internal/pull/15491

image
image

Copy link

vercel bot commented Mar 14, 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 14, 2025 9:56pm

@natikgadzhi
Copy link
Contributor

This is awesome — nice way to wrap things up

@natikgadzhi natikgadzhi merged commit 728c4b9 into master Mar 16, 2025
22 checks passed
@natikgadzhi natikgadzhi deleted the bnchrch/custom-code/docs branch March 16, 2025 21:27
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.

2 participants