Simplify grammar on HTTP Load Balancer #515
Draft
Conversation
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
Update wording from beginning up through "Limit the Number of Connections". Break up long sentences and clarify ambiguous wording, using the linked pages on https://nginx.org/en/docs/ to disambiguate. (Improve readability of overall document from grade 17.6 to grade 14.6.) Consistency changes throughout, favoring the wording most used in this document: Change all "load-balanc*" to "load balanc*" except in URLs. Change "parameter of" to "parameter to". Remove gerunds from subheadings throughout.
github-actions
bot
added
documentation
|
✅ All required contributors have signed the F5 CLA for this PR. Thank you! |
|
I have hereby read the F5 CLA and agree to its terms |
mjang
requested changes
May 5, 2025
| @@ -14,17 +14,17 @@ type: | |||
|
|
|||
| Load balancing across multiple application instances is a commonly used technique for optimizing resource utilization, maximizing throughput, reducing latency, and ensuring fault‑tolerant configurations. | |||
|
|
|||
| Watch the [F5 NGINX Plus for Load Balancing and Scaling](https://www.nginx.com/resources/webinars/nginx-plus-for-load-balancing-30-min/) webinar on demand for a deep dive on techniques that NGINX users employ to build large‑scale, highly available web services. | |||
| The [F5 NGINX Plus for Load Balancing and Scaling](https://www.nginx.com/resources/webinars/nginx-plus-for-load-balancing-30-min/) webinar offers a deep dive on techniques to build large‑scale, highly available web services. | |||
There was a problem hiding this comment.
Per our style guide, we prefer active voice.
Suggested change
| The [F5 NGINX Plus for Load Balancing and Scaling](https://www.nginx.com/resources/webinars/nginx-plus-for-load-balancing-30-min/) webinar offers a deep dive on techniques to build large‑scale, highly available web services. | |
| Watch the [F5 NGINX Plus for Load Balancing and Scaling](https://www.nginx.com/resources/webinars/nginx-plus-for-load-balancing-30-min/) webinar, for a deep dive on techniques to build large‑scale, highly available web services. |
|
|
||
| To start using NGINX Plus or NGINX Open Source to load balance HTTP traffic to a group of servers, first you need to define the group with the [`upstream`](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream) directive. The directive is placed in the [`http`](https://nginx.org/en/docs/http/ngx_http_core_module.html#http) context. | ||
| The first step in using NGINX Plus or NGINX Open Source to load balance across a group of servers is to define the group of servers. Define the group of servers with the [`upstream`](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream) directive. The directive is placed in the [`http`](https://nginx.org/en/docs/http/ngx_http_core_module.html#http) context. |
There was a problem hiding this comment.
We prefer active voice:
Suggested change
| The first step in using NGINX Plus or NGINX Open Source to load balance across a group of servers is to define the group of servers. Define the group of servers with the [`upstream`](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream) directive. The directive is placed in the [`http`](https://nginx.org/en/docs/http/ngx_http_core_module.html#http) context. | |
| Use NGINX Plus or NGINX Open Source to load balance across a group of servers. First, define the group of servers with the [`upstream`](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream) directive. Place the directive in the [`http`](https://nginx.org/en/docs/http/ngx_http_core_module.html#http) context. |
|
|
||
| Servers in the group are configured using the [`server`](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server) directive (not to be confused with the `server` block that defines a virtual server running on NGINX). For example, the following configuration defines a group named **backend** and consists of three server configurations (which may resolve in more than three actual servers): | ||
| Servers in the group are configured using the [`server`](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server) directive (not to be confused with the `server` block that defines a virtual server running on NGINX). For example, the following configuration defines a group named **backend** and consists of three server configurations. (This may resolve to more than three actual servers): |
There was a problem hiding this comment.
Suggested change
| Servers in the group are configured using the [`server`](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server) directive (not to be confused with the `server` block that defines a virtual server running on NGINX). For example, the following configuration defines a group named **backend** and consists of three server configurations. (This may resolve to more than three actual servers): | |
| Servers in the group are configured using the [`server`](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server) directive (not to be confused with the `server` block that defines a virtual server running on NGINX). For example, the following configuration defines a group named **backend** and consists of three server configurations. This may resolve to more than three actual servers: |
mjang
approved these changes
May 6, 2025
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.
Update wording from beginning up through "Limit the Number of Connections". Break up long sentences and clarify ambiguous wording, using the linked pages on https://nginx.org/en/docs/ to disambiguate. (Improve readability of overall document from grade 17.6 to grade 14.6.)
Consistency changes throughout, favoring the wording most used in this document: Change all "load-balanc*" to "load balanc*" except in URLs. Change "parameter of" to "parameter to".
Remove gerunds from subheadings throughout.