Skip to content

Commit 168f8b4

Browse files
apgordon312mjangADubhlaoich
authored
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]>
1 parent c8af3ad commit 168f8b4

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

documentation/style-guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ This document provides guidelines specific to documenting F5 NGINX products and
2020

2121
When writing documentation for our project, align with the default guide's voice and tone.
2222

23-
2423
## F5 brand trademarks and product names
2524

2625
- 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
4847

4948
- Using NGINX Plus Docker images with NGINX Instance Manager
5049

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:
5251
- 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.
5355
- 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.
5456

5557

@@ -343,7 +345,6 @@ The table provides guidelines about the terms you should and should not use for
343345
| 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. | |
344346
| 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. | |
345347

346-
---
347348

348349
## Topic types and templates
349350

@@ -466,7 +467,6 @@ Before reloading or restarting NGINX, always check the syntax of the NGINX confi
466467
sudo nginx -t
467468
```
468469

469-
470470
- **sudo systemctl nginx reload**
471471
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.
472472

0 commit comments

Comments
 (0)