Skip to content

docs: fix vpc-peering delete examples#3503

Open
behroozrafii wants to merge 1 commit into
NVIDIA:mainfrom
behroozrafii:behrooz/3153-vpc-peering-delete-id
Open

docs: fix vpc-peering delete examples#3503
behroozrafii wants to merge 1 commit into
NVIDIA:mainfrom
behroozrafii:behrooz/3153-vpc-peering-delete-id

Conversation

@behroozrafii

Copy link
Copy Markdown

Update the VPC peering management manual to use the required --id
option in the delete command synopsis and example.

Related issues

Fixes #3153

Type of Change

  • Add - New feature or capability
  • Change - Changes in existing functionality
  • Fix - Bug fixes
  • Remove - Removed features or deprecated functionality
  • Internal - Internal changes (refactoring, tests, docs, etc.)

Breaking Changes

  • This PR contains breaking changes

Testing

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed
  • No testing required (docs, internal refactor, etc.)

Additional Notes

git diff --check passed. rumdl was not available locally.

Signed-off-by: Behrooz Rafii <brafii@nvidia.com>
@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: e1d64620-5c90-40eb-98a0-eb8442a0937d

📥 Commits

Reviewing files that changed from the base of the PR and between afd6108 and bb00597.

📒 Files selected for processing (1)
  • docs/manuals/vpc/vpc_peering_management.md

Summary by CodeRabbit

  • Documentation
    • Updated the VPC peering deletion instructions to use the --id <PEERING_CONNECTION_ID> option in the command example.

Walkthrough

The VPC peering management manual now uses --id <PEERING_CONNECTION_ID> for the deletion command and its example, matching the CLI syntax.

Changes

VPC peering documentation

Layer / File(s) Summary
Update deletion command syntax
docs/manuals/vpc/vpc_peering_management.md
The deletion command synopsis and example now pass the peering connection ID through the --id flag.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly reflects the main documentation fix for the vpc-peering delete examples.
Description check ✅ Passed The description is directly related to the documented command syntax correction.
Linked Issues check ✅ Passed The change updates the manual synopsis and example to use --id, matching issue #3153.
Out of Scope Changes check ✅ Passed The pull request appears limited to the documented vpc-peering delete syntax correction.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown

🔍 Container Scan Summary

No Grype artifacts were found to aggregate.

@github-actions

Copy link
Copy Markdown

@polarweasel polarweasel left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I'd have made the ID flag more descriptive to match the VPC ID flag earlier, but no big deal 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: vpc-peering delete documented with positional ID, but the CLI requires --id

4 participants