docs: document v3 migration and v6 beta changes - #80
Open
rustatian wants to merge 18 commits into
Open
Conversation
Signed-off-by: Valery Piashchynski <piashchynski.valery@gmail.com>
Signed-off-by: Valery Piashchynski <piashchynski.valery@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Valery Piashchynski <piashchynski.valery@gmail.com>
Signed-off-by: Valery Piashchynski <piashchynski.valery@gmail.com>
Signed-off-by: Valery Piashchynski <piashchynski.valery@gmail.com>
Signed-off-by: Valery Piashchynski <piashchynski.valery@gmail.com>
Signed-off-by: Valery Piashchynski <piashchynski.valery@gmail.com>
Signed-off-by: Valery Piashchynski <piashchynski.valery@gmail.com>
Signed-off-by: Valery Piashchynski <piashchynski.valery@gmail.com>
New keys: prefixes, cache_ttl, cache_miss_ttl, cache_max_entries. Refresh the intro for the in-memory metadata/miss caching, the GET/HEAD method gate, and the weak-etag description (size + mtime).
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
There are a couple of documentation consistency/clarity issues (HTTP zstd page title format and static cache behavior description) that should be corrected to avoid confusing readers.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR consolidates and expands RoadRunner v3-related documentation by adding new docs pages/features (HTTP zstd middleware and gRPC interceptors) and updating existing pages to reflect newer configuration formats and behaviors.
Changes:
- Added new documentation pages for HTTP
zstdmiddleware and gRPC unary interceptors, and linked them from navigation and existing guides. - Reworked AMQP jobs pipeline documentation to describe versioned pipeline config formats (v2 nested exchange/queue vs legacy flat) and added operational notes (read-only RabbitMQ, RPC declaration behavior).
- Updated HTTP docs to include
zstdin the HTTP middleware reference and refreshed static middleware caching/ETag documentation.
File summaries
| File | Description |
|---|---|
SUMMARY.md |
Adds nav entries for HTTP zstd and gRPC Interceptors. |
queues/amqp.md |
Updates AMQP pipeline config docs (v2 nested format, legacy keys, permissions/RPC notes, migration/next links). |
http/zstd.md |
New page documenting HTTP zstd middleware availability, config, and behavior. |
http/static.md |
Updates static middleware docs with cache/prefix options and corrected ETag behavior description. |
http/http.md |
Adds zstd to the allowed HTTP middleware list and notes build requirement. |
grpc/interceptors.md |
New page documenting interceptor contract, config, ordering, and build examples. |
grpc/grpc.md |
Adds a cross-link to the new interceptors documentation. |
Review details
- Files reviewed: 7/7 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| can slow down the overall performance by up to `~10%`, because RoadRunner has to check the path for each file request. | ||
| The `static` HTTP middleware serves static content using RoadRunner on the main HTTP plugin endpoint. | ||
|
|
||
| To avoid a filesystem lookup on every request, the middleware caches file metadata and misses in memory with a short TTL (`10s` by default). A repeated request for the same path is then answered without touching the filesystem, so the overhead of enabling the middleware stays small. The cache trades a few seconds of staleness for that speed: a file added, changed, or removed on disk is picked up within one TTL. Set the TTLs to `0s` to check the filesystem on every request, or run `rr reset static` to flush the cache at once (for example, after a deploy). |
| @@ -0,0 +1,52 @@ | |||
| # HTTP - Zstd middleware | |||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document the v5-to-v6 plugin migration for the upcoming v3 release on
release/v3.Included Changes
Closed PRs