improve readability and grammatical errors

[ChisomUma]

Proposed changes

Problem: The documentation had a grade level of 9 on the Hemingway editor, showing that some sentences were hard to read. Also, the documentation had a few grammatical and punctuation errors. I focused on improving readability and getting the documentation to at least a 7.

Solution: My first approach was to remove all the code snippets and keywords related to the core NGINX product. This allowed me to focus solely on the difficult sentences. Secondly, I rewrote sentences that were very hard to read or needed shorter or simpler explanations. My approach reduced the readability level from 9 to 7, as shown in the image below:

Please focus on (optional): I would love feedback on the writing and areas I could improve upon. Also, I'm open to any changes, updates, and edits to the documentation required of me.

Issue #101

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

• I have read the contributing guidelines
• I have signed the F5 Contributor License Agreement (CLA)
• I have ensured that documentation content adheres to the style guide
• If the change involves potentially sensitive changes, I have assessed the possible impact
• If applicable, I have added tests that prove my fix is effective or that my feature works
• If applicable, I have checked that any relevant tests pass after adding my changes
• I have updated any relevant documentation (README.md and CHANGELOG.md)
• I have rebased my branch onto main
• I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation.

Please refer to our style guide for guidance about placeholder content.

[github-actions]

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
_{Posted by the CLA Assistant Lite bot.}

[ChisomUma]

I have hereby read the F5 CLA and agree to its terms

[mjang]

@ChisomUma , thanks so much! I hope to get to this early next week.

[mjang]

@ChisomUma , thanks so much for your contribution! The work you've done is immense.

To speed the process, I'd like your permission to incorporate (mostly) standard conventions from our style guide.

• You'll still be able to see my comments, as well as the changes that I make to your proposed work.
  • I'll be happy to answer any questions that you have to the changes that I add.
  • You're welcome to use our discussion as a learning process.

I would then submit your work for a second review, as we require two reviews before merging any pull request.

[ChisomUma]

Hi @mjang thank you very much for getting to my contribution. Yes, you have my permission to incorporate standard conventions from the style guide. I'd be happy to learn from this.

[mjang]

The work you've done, @ChisomUma, is fantastic!

I apologize for the large number of comments -- they're primarily related to our style guide at https://github.com/nginx/documentation/blob/main/templates/style-guide.md. It's based on the Microsoft style guide, and I understand if you're not familiar with it.

As the changes I propose are straightforward, with your OK, I'm going to merge these changes directly. You're welcome to ask / object to any of my changes. I'd love to help you get to know NGINX documentation.

I think this process can help improve your skills as a Technical Writer.

[ChisomUma]

Hi @mjang , thank you very much! your suggestions are 100% valid, and I am honored to receive these feedbacks from you. Ill ensure to look more into the style guide next time. You have my OK on these changes. If I have further questions, I'll be sure to ping you :)

[ADubhlaoich]

LGTM!