Skip to content

Conversation

@Ullaakut
Copy link
Contributor

@Ullaakut Ullaakut commented Jan 29, 2021

What does this PR do?

This PR is a follow-up to #7808 which in much the same way, proposes many fixes to the provider documentation pages.

It introduces multiple grammar, phrasing and formatting improvements to the middleware documentation pages. It seeks to improve consistency and not introduce any changes that would make the pages inconsistent with other ones. It does not change things across all documents, but some changes might come in another PR (like introducing a standard for describing default values for options and whether they are optional or required.)

Among the most frequent changes you will find in this PR:

  • Removal of future tense (will do -> does)
  • Replacement of passive voice with active voice
  • Removal of contractions (it's -> it is)
  • Makes admonitions more consistent (title should always be followed with an empty newline before the body of the admonition)

Some of the other notable changes:

  • Simplification of some sentences
  • Attempt to improve some explanations
  • Removal of trailing whitespaces

Because there are a substantial amount of small changes, this PR is bound to introduce some mistakes, so it should be reviewed carefully.

Motivation

Improve the provider documentation pages and try to improve consistency.

More

  • Added/updated documentation

Co-authored-by: Nicholas Wiersma nick@wiersma.co.za

PCM2
PCM2 previously requested changes Feb 10, 2021
Copy link
Contributor

@PCM2 PCM2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Contributor

@ldez ldez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@kevinpollet kevinpollet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Collaborator

@jbdoumenjou jbdoumenjou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants