fluxninja / aperture

Rate limiting, caching, and request prioritization for modern workloads
https://docs.fluxninja.com
Apache License 2.0
622 stars 24 forks source link

update Aperture introduction #3157

Closed harjotgill closed 8 months ago

harjotgill commented 8 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 8 months ago

[!IMPORTANT]

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (2) * `docs/content/get-started/assets/rate-limiter-dashboard-dark.png` is excluded by: `!**/*.png` * `docs/content/get-started/assets/rate-limiter-dashboard-light.png` is excluded by: `!**/*.png`

Walkthrough

The recent updates focus on enhancing the Aperture load management platform, emphasizing a shift towards a distributed system with features like rate limiting, caching, and request prioritization. The changes also include a simplified integration process and improved readability for developers.

Changes

File Path Change Summary
.pre-commit-config.yaml Updated markdownlint-cli2 from v0.7.1 to v0.12.1.
README.md | docs/content/introduction.md Refocused on distributed load management, introduced new features, and updated integration process.
docs/content/get-started/.../get-started.md Updated instructions and images for policy creation and documentation navigation.
sdks/aperture-js/example/.../basic_usage.ts Renamed a flow and reformatted a function for better readability.

Poem

🐇💻 In the code where changes leap, 🌟 A platform grows, not just a tweak. 📜 From load to cache, it's quite a feat, 🎉 A rabbit cheers, the work's complete!


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 .` - `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](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.