Skip to content

Conform to style guide: avoid gerunds #396

Open
@mjang

Description

@mjang

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions