Edits the by Tech Writer Agent following the F5 Technical Writing Sty… - #2204
Merged
travisamartin merged 1 commit intoAug 13, 2026
Merged
Conversation
travisamartin
commented
Aug 12, 2026
| This tutorial uses the following example values. If you use different values, | ||
| substitute them consistently throughout. | ||
| - `kubectl` access to a Kubernetes cluster. | ||
| - Helm installed. |
Contributor
Author
There was a problem hiding this comment.
Do we need to specify the Helm version?
travisamartin
force-pushed
the
nic/plm-install-upgrade-edits
branch
from
August 12, 2026 20:29
c753217 to
cebfe4d
Compare
vepatel
approved these changes
Aug 12, 2026
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
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.
PR description draft
Style edits: plm-installation.md and plm-upgrade.md
This PR applies style edits to both PLM docs to align them with the F5 Technical Writing Style Guide. No technical content was changed.
Product naming (
f5-product-names)Replaced all uses of the
NICabbreviation in body prose with the full product nameNGINX Ingress Controller. Abbreviating NGINX product names isn't permitted. Shell commands, variable names (NIC_NAMESPACE,NIC_RELEASE,NIC_POD), and Helm release names (nic) were left unchanged because they are literal command syntax.Second person and active voice (
second-person,active-voice)k8s.nginx.org/v1Policy manifest…does not need to be rewritten" → "You don't need to rewrite…"Contractions and tense (
contractions,tense)Word list (
word-list)enable-disable)Ambiguous pronouns (
pronouns)Conditional sentences — condition first (
conditional-sentences)helm upgrade" → "When you runhelm upgrade, pass all four values…"Semicolons (
semicolons)`--reuse-values` preserves…; the `--set` flags overlay PLM storage on topsplit into two sentences.Paragraph structure and instruction order (
paragraph-structure,step-formatting)--skip-crds. Apply…first" was contradictory. Rewritten as: "you must apply the controller's own CRDs before runninghelm install", with thekubectl applycommand following naturally.Headings (
headings,step-numbers-in-headings)## Section 1: Attach to a VirtualServer→## Attach to a VirtualServer## Section 2: Attach to an Ingress→## Attach to an Ingress## Create the NIC Policy→## Create the Policy### 1. Upgrade NIC to enable PLM→### 1. Upgrade NGINX Ingress Controller with PLM storage(both sections)The "Section N:" prefix and numbered subheadings act as step numbers in headings, which isn't permitted. The cross-reference prose was updated to use a short bulleted list of links to the renamed headings.
Line wrapping
Removed all manual mid-sentence line breaks in prose. Text now wraps at the editor margin instead of at an arbitrary column, making diffs easier to read.