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

Update low-code-cdk-overview.md #41338

Merged
merged 7 commits into from
Jul 12, 2024
Merged

Conversation

Jeroendevr
Copy link
Contributor

@Jeroendevr Jeroendevr commented Jul 10, 2024

What

For those not using the Builder UI, you might skip the section where the YAML file is called the Connector Manifest. So as a reader you only read the section Configuring the YAML file
Coming from the tutorial I had to search where the Connector Manifest is discussed in more detail.

Rewording

The sentence

The low-code framework involves editing the Connector Manifest a boilerplate YAML file. The general structure of the YAML file is as follows:

Reads as if the Connector Manifest is boilerplate, perhaps its more clear to remove boilerplate?

The low-code framework involves editing the Connector Manifest a YAML file. The general structure of the YAML file is as follows:

How

N.A.

Review guide

N.A

User Impact

Explicit naming that the boilerplate yaml file is the Connector Manifest

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

Copy link

vercel bot commented Jul 10, 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 11, 2024 5:08pm

Copy link

coderabbitai bot commented Jul 10, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

Labels to auto review (1)
  • coderabbit-ai-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Jeroendevr
Copy link
Contributor Author

Now I think about it the header of the paragraph could also be renamed from

Configuring the YAML file

to

Configuring the Connector Manifest file

@marcosmarxm marcosmarxm requested a review from Adorism July 10, 2024 13:01
Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

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

Thanks @Jeroendevr, @Adorism can you take a look into this suggestion?

Copy link
Contributor

@Adorism Adorism left a comment

Choose a reason for hiding this comment

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

Looks good, made an edit suggestion for grammatical clarity.

@Jeroendevr
Copy link
Contributor Author

@Adorism , thank you for approving. Question about this PR. I have updated a couple of times the branch as I thought this was keeping me from merging this PR. But it waits on Run connectors full CI on fork is it usual that it takes two days or is something else going on?
Thanks,

@marcosmarxm marcosmarxm merged commit 92f299d into airbytehq:master Jul 12, 2024
28 checks passed
@marcosmarxm
Copy link
Member

Hello your feedback matters a lot to us. Can you spare just 3 minutes to complete a survey? We’re dedicated to making the contributor experience even better, and your input is key to achieving excellence. Thank you for helping us improve!

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 community
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants