| Original Text (on page) | Issue | Suggested Correction |
|---|---|---|
| “List sroted pods” | Typo | “List sorted pods” |
| “List pods using a different output” | Wording unclear | Could be: “List pods with different output formats” |
| “View all cotainers logs…” | Typo | “View all containers logs…” |
| “locahost-port” | Typo | “localhost-port” |
| “hosts-port” | Wording | Better: “host-port” |
| “Forward to localhost 8090 from pod 6379” | Word order | “Forward pod port 6379 to localhost:8090” |
| “Another example:” with bad line breaks | Formatting | Proper JSON formatting needed |
“delte” in kubectl delte <namespace> |
Typo | “delete” |
| “Or pass stdin to the container in TTY mode:” | Grammar | Add comma → “Or, pass stdin…” |
| “List sroted events” | Typo | “List sorted events” |
| “using images such as nginx or busybox.” | Minor | Capitalize → “Nginx”, “BusyBox” |
| “Show metrics for a given pod and all its containers” | Slight grammar | “…and all of its containers” |
| “Choosing localhost port” | Grammar | “Choose a localhost port” |
| Area | Problem | Recommendation |
|---|---|---|
| Code blocks | Some commands broken by unwanted line spacing/indentation | Use fenced code blocks consistently: bash ... |
| Long JSON/patch commands | Line breaks cause malformed syntax | Keep JSON on one line or clearly multiline formatted |
| Table formatting text in between paragraphs | Inconsistent spacing | Add standard margins/padding for readability |
Large list of describe resources |
Too long + lacks grouping | Collapse with expandable sections or group by API group |
Multiple repeated commands (get deploy) |
Redundant | Keep single canonical example + alternatives inline |
| “Aliases” section | Missing explanation why useful | Add short note: faster kube CLI usage |
| Current Text | Better Modern Practice |
|---|---|
Uses --generator=run-pod/v1 |
This is deprecated — remove usage entirely |
Uses kubectl run for deployments |
Recommend using: kubectl create deployment |
Dry run flag: --dry-run |
Prefer new syntax: --dry-run=client |
kubectl run -i --tty shell example |
Prefer kubectl exec -it <pod> -- bash after controlled creation |