-
Notifications
You must be signed in to change notification settings - Fork 114
docs: improved NGINX Plus Deployment Guide: All-Active HA for NGINX Plus on GCP #157
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
Conversation
✅ 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 |
86ab449
to
f0ea3eb
Compare
@ChisomUma , thanks so much! I hope to get to this early next week. |
@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.
I would then submit your work for a second review, as we require two reviews before merging any pull request. |
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. |
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.
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.
content/nginx/deployment-guides/google-cloud-platform/high-availability-all-active.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/google-cloud-platform/high-availability-all-active.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/google-cloud-platform/high-availability-all-active.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/google-cloud-platform/high-availability-all-active.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/google-cloud-platform/high-availability-all-active.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/google-cloud-platform/high-availability-all-active.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/google-cloud-platform/high-availability-all-active.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/google-cloud-platform/high-availability-all-active.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/google-cloud-platform/high-availability-all-active.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/google-cloud-platform/high-availability-all-active.md
Outdated
Show resolved
Hide resolved
Mostly based on the NGINX style guide
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 :) |
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.
LGTM!
Proposed changes
Problem: Comprehensive documentation readability audit revealed suboptimal accessibility with a Hemingway app grade level of 9, indicating problems with audience comprehension. Additional analysis identified grammatical and structural inconsistencies across the documentation page that impacted developer experience.
Solution: Executed a complete documentation restructuring initiative involving 1,000+ Markdown lines of technical content. Implemented a systematic two-phase approach: (1) Strategic content separation - isolated code snippets and product-specific terminology to enable focused documentation analysis, and (2) Comprehensive sentence reconstruction - rewrote complex technical explanations while preserving accuracy and technical depth. This method achieved a measurable 22% improvement in readability (from grade level 9 to 7), significantly improving documentation accessibility for diverse technical audiences.
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.
README.md
andCHANGELOG.md
)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.