-
Notifications
You must be signed in to change notification settings - Fork 114
Update EC2 Instances for NGINX page #184
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
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.
Changes generally LGTM: I may do a second pass in the interim period waiting for another TW to take a look.
With regard to your questions:
- Yeah, might as well just delete the old ones.
- I think leaving out the section is fine. We haven't localised the documentation, so having a section with broken links whose only substitute is not in English hurts the overall flow of the document.
Since you're looking at general improvements beyond correcting text, the archetypes I migrated into the repository might be of interest:
https://raw.githubusercontent.com/nginx/documentation/refs/heads/main/archetypes/default.md
We have some standardized page-level information architecture we're slowly applying to pages as we work on them.
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
@ADubhlaoich I deleted the unused images and updated the list styles to take advantage of Hugo's automatic enumeration. Regarding the default archetype, I wasn't sure if for instance the metadata in the archetype represents a new default, or if I should override it with the specific settings in this article. For instance, the archetype has |
The archetype shows the new "defaults" in terms of what parameters each document should have and what the precise ordering is.
The only strictly necessary fields are title and weight: the former is the page title, while the latter affects the ordering of pages or folders that the page is part of.
For this document, you'd re-order the fields, throw the doctypes line into oblivion and add type: how-to and product: NGINX+. description can go between weight and toc. The product value is determined by where the document lives, not what the subject focus is for the text. The distinction is important, 'cause you'll sometimes see information related to one project inside the documentation for another. |
@ADubhlaoich thanks for the detailed explanation and guidance. I updated the metadata to match the new default archetype. |
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
content/nginx/deployment-guides/amazon-web-services/ec2-instances-for-nginx.md
Outdated
Show resolved
Hide resolved
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.
Looks great! Thanks for the edits 😊
Approved with some suggested style tweaks.
Co-authored-by: Travis Martin <33876974+travisamartin@users.noreply.github.com>
Proposed changes
Problem: The "Creating Amazon EC2 Instances" was last updated about 6 years ago and has fallen out of date with the current flow of creating EC2 instances on AWS. The screenshots and some of the links were outdated. The page did also not comply with Hugo formatting standards, and the current style guide. The Hemingway editor's readability score was 8.
Solution:
Testing: Followed the instructions in the guide to make sure they work and reflect the current AWS UI flow.
Please focus on (optional):
static/img/
as instructed in the Contributing docs. Should I remove the old screenshots linked in the original version of the article?Closes #99
Checklist
Before merging a pull request, run through this checklist and mark each as complete.
README.md
andCHANGELOG.md
)