Forward-merge release/0.5 into main#380
Merged
Merged
Conversation
#### Overview Reorganize and expand NeMo Relay plugin documentation, including built-in component configuration and all four plugin authoring paths. - [x] I confirm this contribution is my own work, or I have the right to submit it under this project's license. - [x] I searched existing issues and open pull requests, and this does not duplicate existing work. #### Details - Group built-in component configuration under `Configure Plugins` and add configuration guides for model pricing, discoverable plugins, and component-specific settings. - Organize plugin authoring into language binding, native dynamic, and Rust/Python gRPC worker paths. - Add standalone examples, runtime discovery guidance, lifecycle cleanup, compatibility links, and backward-compatible configuration redirects. - Update navigation and entry-point documentation for the new hierarchy. #### Where should the reviewer start? Start with `docs/build-plugins/about.mdx`, `docs/configure-plugins/about.mdx`, and `fern/docs.yml`. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Closes RELAY-317 - Closes RELAY-320 #### Validation - `just docs` - `just docs-linkcheck` - `uv run pre-commit run lychee` - Python, Node.js, and Rust documentation-fence syntax checks ## Summary by CodeRabbit * **Documentation** * Expanded and reorganized plugin documentation: Observability (ATOF/ATIF/exporters), Adaptive, NeMo Guardrails, PII redaction, and Model pricing. * Added new guides for discoverable plugins and dynamic plugin authorship, including Native Dynamic and gRPC Worker (protocol + Python/Rust examples). * Updated lifecycle, validation/initialization/teardown walkthroughs, and clarified semantics around exporters and pricing; removed an older “code examples” page. * **Chores** * Refreshed documentation navigation and standardized internal link paths, including new redirects to preserve older URLs. Authors: - Will Killian (https://github.com/willkill07) Approvers: - Bryan Bednarski (https://github.com/bbednarski9) - https://github.com/lvojtku URL: #361
Author
|
FAILURE - Unable to forward-merge due to an error, manual merge is necessary. Do not use the IMPORTANT: When merging this PR, do not use the auto-merger (i.e. the |
#### Overview Update the documentation-site release notes for NVIDIA NeMo Relay 0.5 and add a maintainer skill that gathers release evidence from Git history. - [x] I confirm this contribution is my own work, or I have the right to submit it under the project license. - [x] I searched existing issues and open pull requests, and this does not duplicate existing work. #### Details - Replace the stale 0.4 release-note content with the 0.5 compatibility migrations, dynamic plugin capabilities, CLI diagnostics, and runtime and observability updates. - Preserve the complete fixed-item history recorded in the 0.3 and 0.4 release-note pages under release-labelled sections. - Add `draft-release-notes`, including a read-only Git evidence collector that compares release-note trees and groups commits for maintainer review. #### Where should the reviewer start? Start with `docs/about-nemo-relay/release-notes/known-issues.mdx` for the complete prior-release fix history, then review `.agents/skills/draft-release-notes/SKILL.md` and its evidence collector. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Relates to: none ## Summary by CodeRabbit * **Documentation** * Updated NeMo Relay release notes from **0.4** to **0.5**, including highlights, release scope/capabilities, and compatibility/migration changes. * Refreshed **known issues** and “Fixed in” notes for NeMo Relay **0.5**, plus reorganized prior-release sections. * **New Features** * Added a guided **Draft Release Notes** workflow to standardize evidence-based authoring, claim validation, and targeted MDX updates. * Introduced an evidence-collection helper that summarizes Git/doc changes between release references for use during drafting and review. Authors: - Will Killian (https://github.com/willkill07) Approvers: - Bryan Bednarski (https://github.com/bbednarski9) - https://github.com/lvojtku URL: #362
github-actions
Bot
added
size:XXL
Codecov Report✅ All modified and coverable lines are covered by tests. ❌ Your project check has failed because the head coverage (94.40%) is below the target coverage (95.00%). You can increase the head coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #380 +/- ##
==========================================
- Coverage 93.46% 92.98% -0.48%
==========================================
Files 220 220
Lines 60961 60580 -381
Branches 90 90
==========================================
- Hits 56973 56326 -647
- Misses 3988 4254 +266
Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
#### Overview Generate complete API references for published NeMo Relay Rust crates and Python packages. - [x] I confirm this contribution is my own work, or I have the right to submit it under this project's license. - [x] I searched existing issues and open pull requests, and this does not duplicate existing work. #### Details - Include the published types, native plugin, worker protocol, and worker SDK crates in Rust reference generation. - Generate package-scoped Python references for both `nemo-relay` and `nemo-relay-plugin`; the latter renders its public worker SDK symbols. - Redirect the legacy PII Python-reference URL to its package-scoped location. #### Where should the reviewer start? Start with `scripts/docs/generate_python_library_reference.py` and `scripts/docs/generate_rust_library_reference.py`, which declare the generated package and crate surfaces. Validation: `just docs`; `uv run pre-commit run --all-files`. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Relates to: none ## Summary by CodeRabbit * **New Features** * Enhanced the Python API reference generator to support multiple packages with package-aware URLs, navigation, and landing pages. * Expanded the Rust API reference generation to cover additional NeMo Relay crates. * **Documentation** * Updated documentation redirect rules, including restoration of the release-notes “related topics” redirect and added new generated API reference redirects, plus build plugin guide and CLI “about” redirects. * Updated the “Plugin Configuration Files” documentation route to the new path. * **Bug Fixes** * Fixed legacy documentation redirects (including the `pii-redaction` destination). Signed-off-by: Will Killian <wkillian@nvidia.com>
#### Overview Update documentation CODEOWNERS entries so NAT developers are requested alongside technical writers. - [x] I confirm this contribution is my own work, or I have the right to submit it under this project's license. - [x] I searched existing issues and open pull requests, and this does not duplicate existing work. #### Details - Add `@NVIDIA/nat-developers` to the `docs/` and `fern/` ownership rules. - Preserve the existing technical-writer reviewer on both rules. #### Where should the reviewer start? Review `.github/CODEOWNERS`; it is the only changed file. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Closes RELAY-444 ## Summary by CodeRabbit * **Chores** * Updated documentation ownership rules for repo docs-related paths. * Added an additional owner for `docs/` and `fern/` to broaden review coverage. Authors: - Will Killian (https://github.com/willkill07) Approvers: - Eric Evans II (https://github.com/ericevans-nv) URL: #384
Member
|
Closing due to needing manual merge |
2 tasks
Member
|
Reopening per the documented manual forward-merge process. The history-preserving merge is being handled in #385; this original ops-bot PR must remain open so it can complete automatically after the manual merge lands. |
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
1 participant
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.
Forward-merge triggered by push to release/0.5 that creates a PR to keep main up-to-date. If this PR is unable to be immediately merged due to conflicts, it will remain open for the team to manually merge. See forward-merger docs for more info.