You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: Add guidance for article usage to style guide (#510)
This commit adds guidance on article usage when referring to
product names, which was notably absent. The section as a whole
will likely be rewritten in the future for conciseness.
---------
Co-authored-by: Mike Jang <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Copy file name to clipboardExpand all lines: documentation/style-guide.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,6 @@ This document provides guidelines specific to documenting F5 NGINX products and
20
20
21
21
When writing documentation for our project, align with the default guide's voice and tone.
22
22
23
-
24
23
## F5 brand trademarks and product names
25
24
26
25
- On the first mention of an enterprise NGINX product in a document, use the full product name. For example:
@@ -48,8 +47,11 @@ When writing documentation for our project, align with the default guide's voice
48
47
49
48
- Using NGINX Plus Docker images with NGINX Instance Manager
50
49
51
-
- Don't use articles ("the", "a") in front of product names. For example, use
50
+
- Don't use articles ("the", "a") in front of product names. For example, use:
52
51
- NGINX Agent (not "the NGINX Agent").
52
+
- An article can be used if the product name is qualifying another noun. For example, use:
53
+
- Edit the NGINX Agent configuration file (not "Edit NGINX Agent configuration file"): In this case, "NGINX Agent" is a descriptor for the term "configuration file".
54
+
- Expose NGINX Agent's REST API: In this case, NGINX Agent is a standalone noun phrase, and it "possesses" the REST API.
53
55
- Always use the full brand name in the meta description. The meta description does not count as first mention of the product in the document.
54
56
55
57
@@ -343,7 +345,6 @@ The table provides guidelines about the terms you should and should not use for
343
345
| Wizard and wizard | When documenting the GUI, you can capitalize Wizard if appropriate, such as for the Network Access Setup Wizard. When writing about wizards in general, or when a page title of a dialog box or GUI does not show Wizard in uppercase format, you can leave wizard in lowercase format. ||
344
346
| WWW or www | Do not include www. in web addresses In text, do not use WWW, but use Internet instead. Of course, you can use www as part of a URL. Although we're moving away from that, too. ||
345
347
346
-
---
347
348
348
349
## Topic types and templates
349
350
@@ -466,7 +467,6 @@ Before reloading or restarting NGINX, always check the syntax of the NGINX confi
466
467
sudo nginx -t
467
468
```
468
469
469
-
470
470
-**sudo systemctl nginx reload**
471
471
Use `reload` to apply configuration changes without stopping active connections. This keeps the NGINX service running while updating the configuration. It’s the preferred option for most changes because it avoids downtime and doesn’t interrupt users.
0 commit comments