-
Notifications
You must be signed in to change notification settings - Fork 45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Edited doc to improve readability #334
Conversation
If you can find ways to shorten sentences, I generally advocate for it. Longer sentences aren't necessarily better ones. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally LGTM!
Making sure @y82 is tagged as the assigned TW (technical writer) for NGINX Plus: I'm going to flag the use of links internally.
We want all our links handled using Hugo references, and have a directive to avoid any inline HTML.
Readability calculators such as Flesch-Kincaid credit shorter sentences and words with fewer syllables. Here's their equation:
|
content/nginx/deployment-guides/load-balance-third-party/apache-tomcat.md
Outdated
Show resolved
Hide resolved
…e-tomcat.md Co-authored-by: Travis Martin <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: I've corrected the entry which refers to Nginx
. We use NGINX
in our documentation.
@noxian-byte thank you for your contribution! |
Proposed changes
Problem: The page had not been revised since May 2024.
Solution:
Please focus on (optional): I used the Hemingway Editor as instructed and have noticed that most of the sentences were marked as hard to read simply because of the length.How much emphasis is placed on reducing word count when readability is a priority?
This PR addresses Issue #138