Skip to content

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

Closed
mjang opened this issue Apr 11, 2025 · 3 comments
Closed

Conform to style guide: avoid gerunds #396

mjang opened this issue Apr 11, 2025 · 3 comments
Assignees
Labels
community documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@mjang
Copy link
Contributor

mjang commented Apr 11, 2025

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.

Image

Related: see this style guide entry on headings:

Image

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:

  • Troubleshooting
  • Testing

Sometimes, judgement is required in these cases.

"Fork" our repository

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

Image

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.

Image

Acceptance criteria

Conversion of gerunds to appropriate alternatives.

@mjang mjang added documentation Improvements or additions to documentation good first issue Good for newcomers community labels Apr 11, 2025
@mjang mjang changed the title Conform to style guide: gerunds Conform to style guide: avoid gerunds Apr 15, 2025
janetjotw added a commit to janetjotw/nginx-documentation that referenced this issue Apr 16, 2025
Removed gerund from headings for Issue nginx#396.
ADubhlaoich pushed a commit that referenced this issue Apr 17, 2025
Remove gerund from headings.
@apgordon312
Copy link
Contributor

Hi Mike! Please assign this issue to me.

@apgordon312
Copy link
Contributor

@mjang This issue can be closed!

@mjang mjang closed this as completed May 7, 2025
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
Projects
None yet
Development

No branches or pull requests

2 participants