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

Overhaul concept docs #3087

Closed tanveergill closed 8 months ago

tanveergill commented 8 months ago

Description of change

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 8 months ago

Walkthrough

The changes reflect a restructuring and clarification of the documentation for a system's request handling components. The updates include repositioning of sections within the sidebar, refining explanations of scheduling mechanisms, and introducing new concepts like the Concurrency Limiter. Links have been updated to align with the reorganized content, and Prometheus metrics have been enhanced for better observability of the system's flow control capabilities.

Changes

File Path Change Summary
api/aperture/policy/language/v1/flowcontrol.proto Updated documentation links for Load Scheduler and workload definition.
docs/content/concepts/advanced/advanced.md Changed sidebar_position from 8 to 10.
docs/content/concepts/advanced/agent-group.md Updated hyperlink to point to new quota scheduler documentation location.
docs/content/concepts/cache.md Updated sidebar_position from 7 to 9.
docs/content/concepts/concurrency-limiter.md Added new documentation for Concurrency Limiter.
docs/content/concepts/control-point.md Reordered control points and updated Feature Control Points content.
docs/content/concepts/{flow-label,flow-lifecycle,rate-limiter}.md Updated links and revised explanations.
docs/content/concepts/request-prioritization/{concurrency-scheduler,load-scheduler,quota-scheduler,request-prioritization}.md Introduced new documentation and updated sidebar_position, links, and content clarity.
docs/content/concepts/scheduler.md New documentation detailing Scheduler functionality.
docs/content/concepts/selector.md Updated link to Load Scheduler documentation.
docs/content/faq.md Updated links to Load Scheduler and Scheduler documentation.
docs/content/introduction.md Updated feature names and paths.
docs/content/reference/blueprints/load-scheduling/average-latency.md Modified description of load scheduler functionality.
docs/content/reference/configuration/spec.md Updated references to Load Scheduler and workload definition.
docs/content/reference/observability/prometheus-metrics/agent.md Updated Prometheus metrics descriptions and labels.
pkg/policies/flowcontrol/service/check/metrics.go Shifted from single counter to counter vector for checkReceivedTotal in Prometheus metrics.

🐇✨ To docs and links anew we hop, With clearer paths that won't make you stop. Sidebar dances, metrics in rows, In Aperture's garden, the understanding grows. 🌱📚


Tips ### Chat with CodeRabbit Bot (`@coderabbitai`) - You can directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging `@coderabbitai` in a comment. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - You can tag `@coderabbitai` in a PR comment and ask questions about the PR and the codebase. 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.` - `@coderabbitai read the files in the src/scheduler package and generate 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. ### 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.