Skip to content

Conversation

@jawfu-M
Copy link
Contributor

@jawfu-M jawfu-M commented May 27, 2025

NOTE: this is a rewrite only. No technical changes.

The original documentation was slightly difficult to read and follow. It had complex sentences and paragraphs that scored 14 on the Hemmingway app. Some constructs were conflicting or confusing, which took longer to understand.

I improved the document’s readability and clarity, making it accessible to a wider, non-expert audience. Here’s how:

  • Rewrote complex paragraphs graded at 14 to achieve Grade 6 clarity without losing meaning
  • Shortened lengthy sentences to improve readability and flow
  • Converted a dense, difficult step into a clear, bulleted list of actionable tasks
  • Replaced overly technical words with simpler language
  • Clarified technical concepts to make them understandable for non-specialist readers
  • Shifted tone from passive to active voice to increase directness

Testing: I used the Hemmingway app to confirm readability and studied the terms individually to ensure they were all updated.

  • [ ✔️] I have read the contributing guidelines
  • [ ✔️] I have signed the F5 Contributor License Agreement (CLA)
  • [✔️] I have rebased my branch onto main
  • [✔️ ] I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • [✔️ ] I have ensured that the commit messages adhere to Conventional Commits
  • [ ✔️] I have ensured that documentation content adheres to the style guide
  • [ ✔️] If the change involves potentially sensitive changes1, I have assessed the possible impact
  • [ ✔️] If applicable, I have added tests that prove my fix is effective or that my feature works
  • [ ✔️] I have ensured that existing tests pass after adding my changes
  • [✔️ ] If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. 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.

@jawfu-M jawfu-M requested a review from a team as a code owner May 27, 2025 17:46
@jawfu-M
Copy link
Contributor Author

jawfu-M commented Jul 4, 2025

Sort of LGTM: I made a large amount of suggestions to fix formatting issues introduced by the PR.

Most of them related to inline links being turned into production URLs and raw HTML being added to the Markdown text.

I'm happy to give an approval on the basis of my edit suggestions being implemented, but @y82 is the final call on if this can be merged or not.

Hi @ADubhlaoich 👋

Thank you for your thoughtful suggestions! I’ve committed all the changes and will closely review the rest of the file to catch any similar issues.

Really appreciate your patience as I get up to speed (Whew!). Your feedback has been incredibly helpful. Please let me know if you spot anything else.

Thank you so much once again. :)

@ADubhlaoich ADubhlaoich self-assigned this Nov 28, 2025
@ADubhlaoich
Copy link
Member

I have accepted all of the proposed edit suggestions for this PR.

I am working on a separate PR which targets this one to address content and style changes, as it has been inactive for many months.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community Issues or pull requests started by community members documentation Improvements or additions to documentation product/nginx-plus Issues related to NGINX Plus (and NGINX Open Source in docs.nginx.com)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Analyze NGINX Plus Deployment Guide: Azure VMs

5 participants