From 78e53324850a701555b41a068679a5f83ba44a15 Mon Sep 17 00:00:00 2001 From: apgordon312 Date: Sun, 4 May 2025 11:46:38 -0700 Subject: [PATCH 1/2] Update style-guide.md Added clarification about when to use articles in front of a product name. --- templates/style-guide.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/templates/style-guide.md b/templates/style-guide.md index d97e06a98..7dea90a3b 100644 --- a/templates/style-guide.md +++ b/templates/style-guide.md @@ -48,8 +48,11 @@ When writing documentation for our project, align with the default guide's voice - Using NGINX Plus Docker images with NGINX Instance Manager -- Don't use articles ("the", "a") in front of product names. For example, use +- Don't use articles ("the", "a") in front of product names. For example, use: - NGINX Agent (not "the NGINX Agent"). + - EXCEPTION: Use an article ("the", "a") if the product name is qualifying another noun. For example, use: + - 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". + - Expose NGINX Agent's REST API ← In this case, NGINX Agent is a standalone noun phrase, and it "possesses" the REST API. - 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. From bbac7e90a9e05619dd2514a3e18d07d4c2e8be7e Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Tue, 1 Jul 2025 16:59:27 +0100 Subject: [PATCH 2/2] feat: Simplify indentation, remove irregular formatting --- documentation/style-guide.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/documentation/style-guide.md b/documentation/style-guide.md index b5d9d6fea..560ec05cf 100644 --- a/documentation/style-guide.md +++ b/documentation/style-guide.md @@ -20,7 +20,6 @@ This document provides guidelines specific to documenting F5 NGINX products and When writing documentation for our project, align with the default guide's voice and tone. - ## F5 brand trademarks and product names - On the first mention of an enterprise NGINX product in a document, use the full product name. For example: @@ -50,9 +49,9 @@ When writing documentation for our project, align with the default guide's voice - Don't use articles ("the", "a") in front of product names. For example, use: - NGINX Agent (not "the NGINX Agent"). - - EXCEPTION: Use an article ("the", "a") if the product name is qualifying another noun. For example, use: - - 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". - - Expose NGINX Agent's REST API ← In this case, NGINX Agent is a standalone noun phrase, and it "possesses" the REST API. +- An article can be used if the product name is qualifying another noun. For example, use: + - 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". + - Expose NGINX Agent's REST API: In this case, NGINX Agent is a standalone noun phrase, and it "possesses" the REST API. - 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. @@ -346,7 +345,6 @@ The table provides guidelines about the terms you should and should not use for | 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. | | | 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. | | ---- ## Topic types and templates @@ -469,7 +467,6 @@ Before reloading or restarting NGINX, always check the syntax of the NGINX confi sudo nginx -t ``` - - **sudo systemctl nginx reload** 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.