Description
Overview
Open to multiple community members.
As a writer, I want to update documentation to conform with the NGINX style guide
This issue is focused on the gerund, as described in the style guide.
Related: see this style guide entry on headings:
Description
Specifically, I see a number of pages where headings start with a gerund. As community members address these examples, this list may go "out of date." You're welcome to look for (and propose changes to) other examples with gerund-based headers.
Examples:
- https://docs.nginx.com/nginx/admin-guide/basic-functionality/runtime-control/
- https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/
- https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus-amazon-web-services/
- https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus-google-cloud-platform/
- https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus-microsoft-azure/
- https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-docker/
- https://docs.nginx.com/nginx/deployment-guides/amazon-web-services/ingress-controller-elastic-kubernetes-services/
- https://docs.nginx.com/nginx/admin-guide/load-balancer/using-proxy-protocol/
- https://docs.nginx.com/nginx/admin-guide/content-cache/content-caching/
- https://docs.nginx.com/nginx/admin-guide/web-server/web-server/
- https://docs.nginx.com/nginx/admin-guide/web-server/serving-static-content/
Note: there are some terms that are gerunds that are in common use, and therefore can remain as gerunds. Examples:
- Troubleshooting
- Testing
Sometimes, judgement is required in these cases.
"Fork" our repository
- Navigate to https://github.com/nginx/documentation
- Select Fork -> Create a new fork
- Accept the option to "Copy the
mainbranch only" and select "Create fork"
Tip for contributors who don't know Git
You don't need to know Git to make these changes
Near the bottom of each documentation page, you'll see three links:
- View source
- Edit this page
- Create a new issue
To propose a change:
- Select the "Edit this page" link. It opens the source code for the page, in edit mode.
- You can propose changes directly in that screen.
- When you've made all the changes that you want to make, select the "Commit changes ... " button.
- Follow the prompts to create a pull request.
Note: if you see this error message, follow the steps in the "Fork" our repository section and try again.
Acceptance criteria
Conversion of gerunds to appropriate alternatives.