generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 82
Conform to style guide: avoid gerunds #396
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
Labels
community
documentation
Improvements or additions to documentation
good first issue
Good for newcomers
Comments
janetjotw
added a commit
to janetjotw/nginx-documentation
that referenced
this issue
Apr 16, 2025
Removed gerund from headings for Issue nginx#396.
This was referenced Apr 16, 2025
Merged
ADubhlaoich
pushed a commit
that referenced
this issue
Apr 17, 2025
Hi Mike! Please assign this issue to me. |
@mjang This issue can be closed! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
community
documentation
Improvements or additions to documentation
good first issue
Good for newcomers
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:
Note: there are some terms that are gerunds that are in common use, and therefore can remain as gerunds. Examples:
Sometimes, judgement is required in these cases.
"Fork" our repository
main
branch 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:
To propose a change:
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.
The text was updated successfully, but these errors were encountered: