fix(networking): remove backticks in cloud-config yaml#978
fix(networking): remove backticks in cloud-config yaml#978starbops wants to merge 1 commit intoharvester:mainfrom
Conversation
starbops
requested review from
Copilot and
jillian-maroket
and removed request for
Copilot
|
|
Hi @akashraj4261. Could you help review this. Thank you. |
Signed-off-by: Zespre Chang <zespre.chang@suse.com>
There was a problem hiding this comment.
Pull request overview
This PR improves the copy/paste usability of the cloud-config YAML snippets in the Kube-OVN VPC networking documentation by removing stray inline-code backticks and presenting the YAML as a normal indented block.
Changes:
- Replaced the incorrectly backticked
usersYAML entries with standard YAML indentation. - Applied the same formatting fix across current docs and versioned docs (v1.6, v1.7).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| docs/networking/kubeovn-vpc.md | Fixes cloud-config YAML snippet formatting in two sections. |
| versioned_docs/version-v1.6/networking/kubeovn-vpc.md | Mirrors the same YAML formatting adjustment for v1.6 docs. |
| versioned_docs/version-v1.7/networking/kubeovn-vpc.md | Mirrors the same YAML formatting adjustment for v1.7 docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| groups: [ sudo ] | ||
| shell: /bin/bash | ||
| sudo: ALL=(ALL) NOPASSWD:ALL | ||
| lock\_passwd: false |
There was a problem hiding this comment.
In a fenced code block, underscores don’t need escaping; the backslash becomes part of the copied YAML key. lock\_passwd will not be recognized by cloud-init (should be lock_passwd). Remove the backslash so the snippet is valid when copied.
| lock\_passwd: false | |
| lock_passwd: false |
| groups: [ sudo ] | ||
| shell: /bin/bash | ||
| sudo: ALL=(ALL) NOPASSWD:ALL | ||
| lock\_passwd: false |
There was a problem hiding this comment.
In a fenced code block, underscores don’t need escaping; the backslash becomes part of the copied YAML key. lock\_passwd will not be recognized by cloud-init (should be lock_passwd). Remove the backslash so the snippet is valid when copied.
| lock\_passwd: false | |
| lock_passwd: false |
| groups: [ sudo ] | ||
| shell: /bin/bash | ||
| sudo: ALL=(ALL) NOPASSWD:ALL | ||
| lock\_passwd: false |
There was a problem hiding this comment.
In a fenced code block, underscores don’t need escaping; the backslash becomes part of the copied YAML key. lock\_passwd will not be recognized by cloud-init (should be lock_passwd). Remove the backslash so the snippet is valid when copied.
| lock\_passwd: false | |
| lock_passwd: false |
| groups: [ sudo ] | ||
| shell: /bin/bash | ||
| sudo: ALL=(ALL) NOPASSWD:ALL | ||
| lock\_passwd: false |
There was a problem hiding this comment.
In a fenced code block, underscores don’t need escaping; the backslash becomes part of the copied YAML key. lock\_passwd will not be recognized by cloud-init (should be lock_passwd). Remove the backslash so the snippet is valid when copied.
| lock\_passwd: false | |
| lock_passwd: false |
| groups: [ sudo ] | ||
| shell: /bin/bash | ||
| sudo: ALL=(ALL) NOPASSWD:ALL | ||
| lock\_passwd: false |
There was a problem hiding this comment.
In a fenced code block, underscores don’t need escaping; the backslash becomes part of the copied YAML key. lock\_passwd will not be recognized by cloud-init (should be lock_passwd). Remove the backslash so the snippet is valid when copied.
| lock\_passwd: false | |
| lock_passwd: false |
| groups: [ sudo ] | ||
| shell: /bin/bash | ||
| sudo: ALL=(ALL) NOPASSWD:ALL | ||
| lock\_passwd: false |
There was a problem hiding this comment.
In a fenced code block, underscores don’t need escaping; the backslash becomes part of the copied YAML key. lock\_passwd will not be recognized by cloud-init (should be lock_passwd). Remove the backslash so the snippet is valid when copied.
| lock\_passwd: false | |
| lock_passwd: false |
Correct the YAML format for better copy-and-paste usability.