docs(nim): edit pass on rootless Docker Compose guide#1969
Merged
travisamartin merged 2 commits intoMay 20, 2026
Conversation
Apply style guide corrections to deploy-nim-rootless-docker-compose.md: - Replace NIM abbreviation with NGINX Instance Manager throughout prose (f5-product-names: never abbreviate NGINX product names) - Fix passive voice constructions to active voice (active-voice) - Replace 'Launch' with 'Start', 'Once' with 'When', 'Modify' with 'Change', 'via' with 'using', 'as' (causal) with 'because' (word-list) - Split 32-word sentence into two shorter sentences (sentence-length) - Rewrite 'No image rebuild required/needed' constructions as 'You don't need to rebuild the image' (active-voice) - Remove parenthetical (NIM) abbreviation introduction (f5-product-names)
|
✅ All required contributors have signed the F5 CLA for this PR. Thank you! |
github-actions
Bot
added
documentation
5 tasks
✅ Deploy Preview will be available once build job completes!
|
Contributor
|
Looks good to me |
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
2 participants
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.
Summary
Edit pass on
content/nim/deploy/docker/deploy-nim-rootless-docker-compose.mdapplying F5 Technical Writing Style Guide corrections.Changes
f5-product-names
(NIM)abbreviation introduction from the first mention — the full product name was already present.NIMabbreviation withNGINX Instance Manager. Code identifiers (NIM_*environment variables,startNIM.sh, thenimservice name,nim:latestimage tag) were left unchanged.active-voice
NIM settings can be changed→you can change NGINX Instance Manager settingsNo Docker image rebuild is required/No image rebuild is needed→You don't need to rebuild the image(three occurrences)configuration is applied fresh on every container start→NGINX Instance Manager applies fresh configuration on every container startpassed in by Docker Compose→that Docker Compose passes inword-list
via→using(in description front matter)Launch→StartOnce(temporal) →WhenModify→Changemodified(configuration value) →changedas(causal) →becausesentence-length