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 SDK READMEs for v1 announcement #3175

Merged
merged 1 commit into from
Jan 30, 2024
Merged

Conversation

hdkshingala
Copy link
Contributor

@hdkshingala hdkshingala commented Jan 30, 2024

Summary by CodeRabbit

  • Documentation
    • Updated README.md for C#, Go, Java, JavaScript, and Python SDKs to announce the launch of version 1 of the managed rate limiting service.
    • Added links to the launch blog post, Product Hunt, and Discord for feedback and support across all SDKs.
    • Changed titles to emphasize "Rate Limiting for [Language] Applications," shifting focus from the SDKs to the rate limiting service functionality.

@hdkshingala hdkshingala requested a review from a team as a code owner January 30, 2024 10:35
Copy link
Contributor

coderabbitai bot commented Jan 30, 2024

Walkthrough

The updates across various SDK README.md files reflect a unified shift in focus from merely presenting SDKs for different programming languages to highlighting the launch of a version 1 managed rate limiting service. This service is now the centerpiece, with the documentation emphasizing support, feedback channels, and a rebranding of the SDK titles to reflect their core functionality of rate limiting in respective programming languages.

Changes

Files Change Summary
.../aperture-csharp/README.md Launch of v1 managed rate limiting service, new links for engagement, title change to "Rate Limiting for C# Applications."
.../aperture-go/README.md Introduction of launch announcement, support links, focus shift to "Rate Limiting for Golang Applications."
.../aperture-java/README.md Launch of v1 managed rate limiting service announced, title updated to "Rate Limiting for Java Applications."
.../aperture-js/README.md Highlights the launch of the managed rate limiting service, moves focus to service promotion.
.../aperture-py/README.md Announces v1 of the managed rate limiting service, title change to "Rate Limiting for Python Applications."

🐇✨
In the world of code, where limits must be set,
A service emerges, in its prime and yet,
With links and titles, anew and refined,
We hop to the future, with rate limits defined.
🌟🐾


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.
  • 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 from git 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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 7f51b8a and 3a5d0f8.
Files selected for processing (5)
  • sdks/aperture-csharp/README.md (2 hunks)
  • sdks/aperture-go/README.md (1 hunks)
  • sdks/aperture-java/README.md (2 hunks)
  • sdks/aperture-js/README.md (2 hunks)
  • sdks/aperture-py/README.md (2 hunks)
Files skipped from review due to trivial changes (3)
  • sdks/aperture-go/README.md
  • sdks/aperture-java/README.md
  • sdks/aperture-js/README.md
Additional comments: 2
sdks/aperture-py/README.md (1)
  • 18-18: The updated heading "Rate Limiting for Python Applications" aligns with the PR objectives to shift focus from the SDK to the functionality it provides. This change is clear and correctly implemented.
sdks/aperture-csharp/README.md (1)
  • 21-21: The heading change to "Rate Limiting for C# Applications" is correctly implemented and supports the PR's goal of emphasizing the functionality of rate limiting in applications. This is a positive change.

sdks/aperture-py/README.md Show resolved Hide resolved
sdks/aperture-csharp/README.md Show resolved Hide resolved
@hdkshingala hdkshingala merged commit a944906 into main Jan 30, 2024
24 checks passed
@hdkshingala hdkshingala deleted the update-sdk-readme-v1 branch January 30, 2024 10:43
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