docs: add Gmail policy guidance - #6438
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdded Gmail and Google Workspace mail guidance to the network policy examples page, clarifying that no maintained Gmail preset is shipped and showing custom preset examples, apply commands, and validation steps. ChangesGmail Policy Documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/network-policy/integration-policy-examples.mdx (1)
115-117: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winWrap the secret-handling guidance in a
<Warning>callout.This reads like a warning, so it should use the MDX callout pattern required by the docs guidelines. As per coding guidelines, use Fern callout components such as
<Warning>for callouts in MDX pages.♻️ Proposed fix
- Keep Google OAuth client secrets, refresh tokens, app passwords, and downloaded credential JSON files out of policy YAML. - Store credentials through the integration you are running in the sandbox, or through an OpenShell provider path when the integration supports placeholder resolution. + <Warning> + Keep Google OAuth client secrets, refresh tokens, app passwords, and downloaded credential JSON files out of policy YAML. + Store credentials through the integration you are running in the sandbox, or through an OpenShell provider path when the integration supports placeholder resolution. + </Warning>🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/network-policy/integration-policy-examples.mdx` around lines 115 - 117, The secret-handling guidance in the integration policy examples should be presented as an MDX warning callout instead of plain text. Wrap the existing credential guidance in the appropriate Fern callout component, using <Warning> in this document, so the content follows the docs MDX callout pattern and is easy to spot for readers.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/network-policy/integration-policy-examples.mdx`:
- Around line 115-117: The secret-handling guidance in the integration policy
examples should be presented as an MDX warning callout instead of plain text.
Wrap the existing credential guidance in the appropriate Fern callout component,
using <Warning> in this document, so the content follows the docs MDX callout
pattern and is easy to spot for readers.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: a5c28f80-86ad-4d46-b487-505a8f0f8a17
📒 Files selected for processing (1)
docs/network-policy/integration-policy-examples.mdx
apurvvkumaria
left a comment
There was a problem hiding this comment.
Requesting one acceptance correction before this PR can close #3714. The linked issue asks for a best-practice Gmail send/receive tutorial and explicitly refers to a gmail.yaml policy. The current section only tells readers to create a custom preset; it gives neither a concrete minimal policy example (hosts, ports/protocols, allowed executables, schema) nor a link to one. The PR summary also says typical endpoint patterns are listed, but the diff does not list them. A reader cannot follow this end to end. Please either (1) add a validated minimal example for the supported Gmail REST path and clearly separate any IMAP/SMTP rules and their broader L4 risk, or (2) remove the Fixes #3714 claim and frame this as general orientation, with a follow-up issue for the runnable tutorial. The Warning callout suggestion is useful but non-blocking. This PR has no release tag, so I will leave the contributor 24 hours from this review, until 2026-07-09 20:40 UTC, before any maintainer takeover.
Co-authored-by: Glenn-Agent <glenn_agent@163.com> Signed-off-by: Apurv Kumaria <akumaria@nvidia.com>
|
Maintainer salvage pushed as |
Addressed by 346d518: the page now includes validated Gmail REST, IMAP, and SMTP policies, separates the L4 risk, and wraps credential guidance in a Warning. Dismissing this outdated change request without approving; CI remains independently gated.
|
Maintainer follow-up completed at exact head
The deterministic merge-gate checker still reports |
cv
left a comment
There was a problem hiding this comment.
Exact-head independent review at 44f771a is clean. All three Gmail examples validate against the current policy schema; the REST/OAuth paths, IMAP and SMTP endpoints, binary/path globs, and opaque L4 warning match the current provider and OpenShell contracts. All 26 checks are green, CodeRabbit has no unresolved findings, DCO passes, and all commits are Verified. The risky-file result is a docs-only classifier artifact, and the BLOCKED merge state is the independent-review requirement.
Signed-off-by: Carlos Villela <cvillela@nvidia.com>
|
Thanks for the contribution. #5415 has now merged and closes #3714 with a maintained, tested |
Summary
Adds a focused Gmail and Google Workspace Mail section to the integration policy examples. The guidance clarifies that NemoClaw does not currently ship a maintained
gmailpreset, and recommends creating a minimal custom preset for only the Google Mail endpoints and protocols an integration actually needs.Related Issue
Fixes #3714
Changes
outlookpreset for Gmail or Google Workspace Mail.Type of Change
Quality Gates
Verification
Verifiedin GitHubpre-commit,commit-msg, andpre-pushhooks passed, ornpm run check:diffpassed when hooks were skipped or unavailable — command/result:npm run check:diffpassed.npm run docs:check-agent-variantspassed; tests are not applicable because this is documentation-only prose.npm testfor broad runtime/test-harness changes;npm run checkfor repo-wide validation/coverage changes — command/result:npm run docsbuilds without warnings (doc changes only) — command/result:npm run docscompleted with 0 errors and 2 Fern warnings not printed by default.Signed-off-by: Glenn-Agent glenn_agent@163.com
Summary by CodeRabbit