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: update readme #1639

Merged
merged 2 commits into from
Mar 7, 2024
Merged

chore: update readme #1639

merged 2 commits into from
Mar 7, 2024

Conversation

ameypv-rudder
Copy link
Contributor

PR Description

  • Add callout re: Control Plane Lite
  • Minor cleanup to the self-hosted control plane section

Linear task (optional)

Linear task link

Cross Browser Tests

Please confirm you have tested for the following browsers:

  • Chrome
  • Firefox
  • IE11

Sanity Suite

  • All sanity suite test cases pass locally

Security

  • The code changed/added as part of this pull request won't create any security issues with how the software is being used.

- Add callout re: Control Plane Lite
@ameypv-rudder ameypv-rudder added the documentation Improvements or additions to documentation label Mar 7, 2024
@ameypv-rudder ameypv-rudder self-assigned this Mar 7, 2024
Copy link
Contributor

coderabbitai bot commented Mar 7, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

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.

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-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

codecov bot commented Mar 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.44%. Comparing base (c9abc60) to head (a078bc1).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1639   +/-   ##
========================================
  Coverage    52.44%   52.44%           
========================================
  Files          584      584           
  Lines        16662    16662           
  Branches      3234     3234           
========================================
  Hits          8738     8738           
  Misses        6514     6514           
  Partials      1410     1410           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

github-actions bot commented Mar 7, 2024

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
Common Code - No bundling 15.81 KB 15.81 KB (0%) 16.5 KB
Remote Module Federation Mapping - CDN 330 B 330 B (0%) 512 B
Remote Module Federated Plugins - CDN 5.71 KB 5.71 KB (0%) 6 KB
Core ESM - NPM 7.64 KB 7.64 KB (0%) 8 KB
Core CJS - NPM 22.43 KB 22.43 KB (0%) 23 KB
Core - NPM 22.57 KB 22.57 KB (0%) 23 KB
Core Legacy - CDN 42.9 KB 42.9 KB (0%) 44 KB
Core - CDN 22.72 KB 22.72 KB (0%) 23 KB
Core (legacy build) - CDN - v1.1 31.54 KB 31.54 KB (0%) 32 KB
Core - NPM - v1.1 31.52 KB 31.52 KB (0%) 32 KB
Service Worker Module 22.64 KB 22.64 KB (0%) 24 KB
All Integrations (legacy build) - CDN 98.58 KB 98.58 KB (0%) 105 KB

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
saikumarrs
saikumarrs previously approved these changes Mar 7, 2024
Copy link

sonarcloud bot commented Mar 7, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@ameypv-rudder
Copy link
Contributor Author

@saikumarrs incorporated your suggestion - LMK if we are good to go here.

@ameypv-rudder ameypv-rudder merged commit 9a0da16 into develop Mar 7, 2024
11 checks passed
@ameypv-rudder ameypv-rudder deleted the readme-updates branch March 7, 2024 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants