-
Notifications
You must be signed in to change notification settings - Fork 97
Proposed rewrite to "Creating Microsoft Azure Virtual Machines for NGINX Open Source and F5 NGINX Plus" #608
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
base: main
Are you sure you want to change the base?
Conversation
Hello 👋 @y82 |
content/nginx/deployment-guides/microsoft-azure/virtual-machines-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/microsoft-azure/virtual-machines-for-nginx.md
Outdated
Show resolved
Hide resolved
Co-authored-by: yar <y82@users.noreply.github.com>
Co-authored-by: yar <y82@users.noreply.github.com>
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.
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.
content/nginx/deployment-guides/microsoft-azure/virtual-machines-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/microsoft-azure/virtual-machines-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/microsoft-azure/virtual-machines-for-nginx.md
Outdated
Show resolved
Hide resolved
|
||
<a href="/nginx/images/azure-create-vm-networking.png"><img src="/nginx/images/azure-create-vm-networking.png" alt="screenshot of 'Networking' tab on Azure 'Create a virtual machine' page" width="1024" height="718" class="aligncenter size-full wp-image-64994" style="border:2px solid #666666; padding:2px; margin:2px;" /></a> | ||
When this guide was first published, the hourly cost for the six VMs was only $0.008. And this costlier than VMs with basic IP addresses. For current pricing, see the [Microsoft documentation](https://azure.microsoft.com/en-us/pricing/details/ip-addresses/). |
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.
Within the reading flow, this sentence sticks out like a sore thumb.
content/nginx/deployment-guides/microsoft-azure/virtual-machines-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/microsoft-azure/virtual-machines-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/microsoft-azure/virtual-machines-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/microsoft-azure/virtual-machines-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/microsoft-azure/virtual-machines-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/microsoft-azure/virtual-machines-for-nginx.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
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. :) |
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:
Testing: I used the Hemmingway app to confirm readability and studied the terms individually to ensure they were all updated.
README.md
andCHANGELOG.md
Footnotes
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. ↩