Skip to content
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

Add exceptions to the Passive voice rule #810

Merged
merged 1 commit into from
Jun 24, 2024

Conversation

aireilly
Copy link
Member

@aireilly aireilly commented Jun 19, 2024

exceptions:
  - deprecated
  - imported
  - supported
  - trusted
  - tested

removed required

Examples of the above terms in passive usage (lifted from openshift-docs):

  1. Service Catalog is deprecated on {product-title} 4 and later.
  2. When you create the virtual machine (VM), the data volume with the {object} is imported into persistent storage.
  3. This credentials strategy is supported for only new {product-title} clusters and must be configured during installation.
  4. Inject the CA bundle that is trusted by {product-title} into the config map by running the following command:
  5. The default configuration used by DVM is tested in various environments.

After the associated credential is removed, it can be deleted or deactivated on the underlying cloud.

If you deploy using infrastructure that you manage no additional configuration is required.

Update: I removed "removed" and "required" from the list since these seems to me to be "primary" verbs that we do want to rewrite in active form for the most part.

Copy link

Click here to review and test in web IDE: Contribute

Copy link

github-actions bot commented Jun 19, 2024

⚡️ Deploying PR Preview...

@aireilly aireilly force-pushed the passive-updte branch 2 times, most recently from ca1dcc4 to d4d389c Compare June 19, 2024 14:01
@aireilly aireilly changed the title Add deprecated as an exception to Passive voice rule Add exceptions to the Passive voice rule Jun 19, 2024
@aireilly aireilly force-pushed the passive-updte branch 2 times, most recently from a4eaa87 to fec0285 Compare June 19, 2024 14:53
Copy link
Collaborator

@rolfedh rolfedh left a comment

Choose a reason for hiding this comment

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

LGTM – I fully support this change. Vale's current handling of passive voice generates numerous false or weak notifications, often causing them to be ignored. Refining this rule will reduce unnecessary noise and improve the relevance and accuracy of the notifications.

@aireilly aireilly force-pushed the passive-updte branch 3 times, most recently from 324bca8 to 3d58d90 Compare June 24, 2024 09:03
@aireilly aireilly merged commit 3512031 into redhat-documentation:main Jun 24, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants