Skip to content

Commit

Permalink
docs: use input-neutral verbs (#19165)
Browse files Browse the repository at this point in the history
  • Loading branch information
HonkingGoose authored Nov 30, 2022
1 parent 384a235 commit a49e206
Show file tree
Hide file tree
Showing 20 changed files with 35 additions and 35 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ blank_issues_enabled: false
contact_links:
- name: Start a discussion (config, doubts, docs)
url: https://github.com/renovatebot/renovate/discussions/new
about: If you have any questions about bot configuration or doubts about whether you should create a feature request or bug report, or have problems with the documentation please click here to create a Discussion instead of an Issue.
about: If you have any questions about bot configuration or doubts about whether you should create a feature request or bug report, or have problems with the documentation please select the button to create a Discussion instead of an Issue.
6 changes: 3 additions & 3 deletions .github/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ Force pushing a PR is OK when:

Maintainers can suggest changes while reviewing your pull request, please follow these steps to apply them:

1. Batch the suggestions into a logical group by clicking on the **Add suggestion to batch** button
2. Click on the **Commit suggestions** button
1. Batch the suggestions into a logical group by selecting the **Add suggestion to batch** button
1. Select the **Commit suggestions** button

Read the [GitHub docs, Applying suggested changes](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request#applying-suggested-changes) to learn more.

Expand All @@ -56,7 +56,7 @@ Read the [GitHub docs, Applying suggested changes](https://docs.github.com/en/pu
A maintainer/contributor can ask you to make changes, without providing a suggestion that you can apply.
In this case you need to do some work yourself to address the feedback.

Once you've done the work, resolve the conversation by clicking on the **Resolve conversation** button in the PR overview.
Once you've done the work, resolve the conversation by selecting the **Resolve conversation** button in the PR overview.
Avoid posting comments like "I've done the work", or "Done".

Read the [GitHub Docs, resolving conversations](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#resolving-conversations) to learn more.
Expand Down
12 changes: 6 additions & 6 deletions .github/label-actions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,14 @@
#### Finding logs on hosted app
<details><summary>Click me to read instructions</summary>
<details><summary>Select me to read instructions</summary>
If you use the Renovate app (GitHub):
1. Go to the affected PR, and search for "View repository job log here"
1. Click on the link to go to the "Mend Renovate Dashboard" and log in
1. Select the link to go to the "Mend Renovate Dashboard" and log in
1. You are now in the correct repository log overview screen
Expand All @@ -59,7 +59,7 @@
#### Finding logs when self-hosting
<details><summary>Click me to read instructions</summary>
<details><summary>Select me to read instructions</summary>
If you're running self-hosted, run with `LOG_LEVEL=debug` in your environment variables and search for whatever dependency/branch/PR that is causing the problem.
Expand All @@ -69,7 +69,7 @@
### Insufficient logs
<details><summary>Click me to read instructions</summary>
<details><summary>Select me to read instructions</summary>
If you already gave us a log, and the Renovate team said it's not enough, then follow the instructions from the **No logs at all** section.
Expand All @@ -79,13 +79,13 @@
### Formatting your logs
<details><summary>Click me to read instructions</summary>
<details><summary>Select me to read instructions</summary>
Please put your logs in a `<details>` and `<summary>` element like this:
<details><summary>Click me to see logs</summary>
<details><summary>Select me to see logs</summary>
```
Copy/paste your logs here, between the starting and ending backticks
Expand Down
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
- [ ] I have updated the documentation, or
- [ ] No documentation update is required

## How I've tested my work (please tick one)
## How I've tested my work (please select one)

I have verified these changes via:

Expand Down
2 changes: 1 addition & 1 deletion docs/development/help-us-help-you.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ If you feel frustrated because better documentation would have prevented you fro
Sometimes people appear to feel frustrated that their issue or discussion has not got enough attention, and they start commenting on other issues with text such as "I'm also having problems with Gradle! See issue #xyz".
Such comments appear intended to "pressure" Renovate maintainers into taking notice, and rarely do they benefit the people subscribed to the other, mostly-unrelated issues.
Please do not do it.
Click the "Subscribe" button on other issues if you just want to follow them.
Select the "Subscribe" button on other issues if you just want to follow them.

## Reproduce repositories on github.com

Expand Down
4 changes: 2 additions & 2 deletions docs/development/local-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,10 +215,10 @@ Also create documentation for the option in the `docs/usage/configuration-option
It's really easy to debug Renovate with the help of Chrome's inspect tool.
Here's an example:

1. Open `chrome://inspect` in Chrome, then click on "Open dedicated DevTools for Node"
1. Open `chrome://inspect` in Chrome, then select "Open dedicated DevTools for Node"
1. Add a `debugger;` statement somewhere in the source code where you want to start debugging
1. Run Renovate using `yarn debug ...` instead of `yarn start ...`
1. Click "Resume script execution" in Chrome DevTools and wait for your break point to be triggered
1. Select "Resume script execution" in Chrome DevTools and wait for your break point to be triggered

### VS Code

Expand Down
6 changes: 3 additions & 3 deletions docs/usage/configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -558,7 +558,7 @@ Examples of what having a Dependency Dashboard will allow you to do:
This feature allows you to use Renovate's Dependency Dashboard to force approval of updates before they are created.

By setting `dependencyDashboardApproval` to `true` in config (including within `packageRules`), you can tell Renovate to wait for your approval from the Dependency Dashboard before creating a branch/PR.
You can approve a pending PR by ticking the checkbox in the Dependency Dashboard issue.
You can approve a pending PR by selecting the checkbox in the Dependency Dashboard issue.

<!-- prettier-ignore -->
!!! tip
Expand Down Expand Up @@ -3033,8 +3033,8 @@ For this to work, you must enable the [Dependency graph](https://docs.github.com
Follow these steps:

1. While logged in to GitHub, navigate to your repository
1. Click on the "Settings" tab
1. Click on "Code security and analysis" in the sidebar
1. Select the "Settings" tab
1. Select "Code security and analysis" in the sidebar
1. Enable the "Dependency graph"
1. Enable "Dependabot alerts"
1. If you're running Renovate in app mode: make sure the app has `read` permissions for "Vulnerability alerts".
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/configuration-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The `commitMessage` reflects the contents of the branch and is usually the same
`commitMessage` has a default value of `{{commitMessagePrefix}} {{commitMessageAction}} {{commitMessageTopic}} {{commitMessageExtra}} {{commitMessageSuffix}}`, with the intention that you only edit some of those subcomponents.

You usually don't need to edit `commitMessagePrefix`, this option is used by Renovate if it needs to add a prefix to conform to the Semantic Commit convention.
Do not touch this unless you know what you're doing.
Avoid editing the commit message, unless you know what you're doing.

`commitMessageAction` is usually just one word, e.g. 'Update', 'Pin', 'Refresh', etc.
You're probably fine leaving this setting alone, though you can change it.
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/dependency-pinning.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ There are some dependencies that either (a) don't have the potential to break so

For example, it's very hard for `eslint` to break anything in production.
If your build/tests pass, then you are fine.
Consider enabling automerge for all lint packages to save yourself the pointless click when you manually approve them each time.
Consider enabling automerge for all lint packages to save yourself the work of manually approving the update each time.
In this case you might wake up to 5/10 of your overnight Pull Requests having already merged themselves.

Another example of a good candidate for automerging might be a database driver like `node-postgres` (`pg` on npm), if you have 100% test coverage of your API.
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/examples/opentelemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ You should now be able to pick `renovate` under in the field `service` field.
![service picker](../assets/images/opentelemetry_pick_service.png)
Press `Find Traces` to search for all Renovate traces and then click on one of the found traces to open the trace view.
Select `Find Traces` to search for all Renovate traces and then select one of the found traces to open the trace view.
![pick trace](../assets/images/opentelemetry_choose_trace.png)
Expand Down
4 changes: 2 additions & 2 deletions docs/usage/getting-started/installing-onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Otherwise, the process for adding new repositories to a Renovate installation ca

Installing/enabling Mend's Renovate GitHub App is simple.

First, navigate to [https://github.com/apps/renovate](https://github.com/apps/renovate) and click the Install button:
First, navigate to [https://github.com/apps/renovate](https://github.com/apps/renovate) and select the Install button:

![Github App Install button](../assets/images/github-app-install.png){ loading=lazy }

Expand All @@ -27,7 +27,7 @@ Renovate will ignore any repositories that don't have known package files, as we
That said, most people run Renovate on selected repositories.
Unfortunately GitHub doesn't offer a "select all except X, Y, Z" option, so you must select each repository where you want Renovate to run.

Once you're done selecting repositories for Renovate to run on, click the green Install button at the bottom of the page and Renovate will be enabled for those repositories and start the onboarding process.
Once you're done selecting repositories for Renovate to run on, select the green Install button at the bottom of the page and Renovate will be enabled for those repositories and start the onboarding process.

<!-- prettier-ignore -->
!!! note
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/getting-started/private-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ If you are using the main npmjs registry then you can configure just the `npmTok

If you don't want all users of the repository to see the unencrypted token, you can encrypt it with Renovate's public key instead, so that only Renovate can decrypt it.

Go to <https://app.renovatebot.com/encrypt>, paste in your npm token, click "Encrypt", then copy the encrypted result.
Go to <https://app.renovatebot.com/encrypt>, paste in your npm token, select "Encrypt", then copy the encrypted result.

Paste the encrypted result inside an `encrypted` object like this:

Expand Down
4 changes: 2 additions & 2 deletions docs/usage/getting-started/use-cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ You can use Renovate's "Dependency Dashboard" on platforms which support dynamic
When you enable the Dependency Dashboard, Renovate creates a "Dependency Dashboard" issue.
This issue lists all updates which are pending, in progress, or were previously closed ignored.

If you want to get an update ahead of schedule, or want to retry a previously closed update, you can click on the update's checkbox in the Dependency Dashboard.
If you want to get an update ahead of schedule, or want to retry a previously closed update, you can select the update's checkbox in the Dependency Dashboard.

### Dependency Dashboard Approval

Expand All @@ -194,7 +194,7 @@ We call this the "Dependency Dashboard Approval" workflow.
Here's how it works:

- You tell Renovate which package updates need "Dashboard Approval" by setting a custom `packageRule`
- Renovate only raises updates for packages that need "Dashboard Approval" after you click on the corresponding checkbox on the dashboard
- Renovate only raises updates for packages that need "Dashboard Approval" after you select the corresponding checkbox on the dashboard

#### Benefits of using Dependency Dashboard Approval

Expand Down
2 changes: 1 addition & 1 deletion docs/usage/key-concepts/automerge.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Renovate's approach is to ensure that automerging branches are up-to-date with t
This means merging multiple branches in a row won't work reliably, so we prefer not to do that.
What all this means is that Renovate will only automerge at most one branch/PR per target branch per run, before you need to wait for the next run.

As a general guide, we recommend that you enable automerge for any type of dependency updates where you would just click "merge" anyway.
As a general guide, we recommend that you enable automerge for any type of dependency updates where you would just select "merge" anyway.
For any updates where you want to review the release notes - or code - before you merge, you can keep automerge disabled.

Automerge works particularly well for `devDependencies` as well as for production `dependencies` in projects which have great test coverage.
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/key-concepts/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ This section explains some common use cases where having the Dependency Dashboar
Renovate's Dependency Dashboard shows an overview of all updates that are still "to do".

If you close an update PR from Renovate without merging, the Dashboard will list this update in the Closed/Ignored section.
If you later change your mind about the update, you can get a new PR by clicking the corresponding checkbox on the dashboard.
If you later change your mind about the update, you can get a new PR by selecting the corresponding checkbox on the dashboard.

### Dependency Dashboard Approval workflow

Expand Down
4 changes: 2 additions & 2 deletions docs/usage/noise-reduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,9 @@ Granularity must be at least one hour.
Automerging is a Renovate feature that can save you a lot of time/noise directly, while also benefiting grouping and scheduling.
In short: it means that Renovate can merge PRs or even branches itself if they pass your tests.

We recommend that you enable automerge for any type of dependency update where you would just click Merge anyway.
We recommend that you enable automerge for any type of dependency update where you would just select Merge anyway.
We all know that there are some types of updates that we (nearly) always verify manually before merging, and plenty of others that we don't bother looking at unless tests fail.
Every time you click Merge on a Renovate PR without manually testing it, you should consider if you can enable automerge and save yourself the time in future.
Every time you select Merge on a Renovate PR without manually testing it, you should consider if you can enable automerge and save yourself the time in future.

Automerge works particularly well for `devDependencies` and for production `dependencies` that have great test coverage.

Expand Down
2 changes: 1 addition & 1 deletion docs/usage/php.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ If you are using a [privately hosted Composer package](https://getcomposer.org/d
This host rule is best added to the bot's `config.js` config so that it is not visible to users of the repository.
If you are using the hosted Mend Renovate App then you can encrypt it with Renovate's public key instead, so that only Renovate can decrypt it.

Go to [https://app.renovatebot.com/encrypt](https://app.renovatebot.com/encrypt), paste in the secret string you wish to encrypt, click _Encrypt_, then copy the encrypted result.
Go to [https://app.renovatebot.com/encrypt](https://app.renovatebot.com/encrypt), paste in the secret string you wish to encrypt, select _Encrypt_, then copy the encrypted result.
You may encrypt your `password` only, but you can encrypt your `username` as well.

```json
Expand Down
6 changes: 3 additions & 3 deletions docs/usage/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ The text you're looking for is:

> This PR has been generated by Mend Renovate. View repository job log here.
Click on the blue text "here" to go to the Mend Renovate App Dashboard.
Select the blue text "here" to go to the Mend Renovate App Dashboard.
Sign in with your GitHub or GitLab account.
Once you're logged in, you can see the logs for the Renovate jobs on your repository.
You should have access to any repository which you have write access to and which has Renovate installed.

Renovate only makes logs for the last 3 days available.

When you've clicked on a recent job, you'll be able to select a debug level that you care about.
For a full overview, make sure you select the `DEBUG` log level.
After selecting a recent job, you can select the debug level that you care about.
For a full overview, select the `DEBUG` log level.

### Self-hosted

Expand Down
2 changes: 1 addition & 1 deletion docs/usage/updating-rebasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ This way:

## Manual rebasing

You can request that Renovate rebase a PR by ticking the rebase/retry checkbox on GitHub or GitLab.
You can request that Renovate rebase a PR by selecting the rebase/retry checkbox on GitHub or GitLab.
Or you can add a "rebase" label to the PR.
The label name is configurable via the `rebaseLabel` option.

Expand Down
2 changes: 1 addition & 1 deletion lib/modules/datasource/repology/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

To specify which specific repository should be queried when looking up a package, the `packageName` has to have the repository identifier and the package name itself, separated by a slash. As an example, `alpine_3_12/gcc` would look for a binary or source package called `gcc` within the `alpine_3_12` repository.

A [list of all supported repositories](https://repology.org/repositories/statistics) can be found on the Repology homepage. To determine the correct identifier, click on a repository of your choice and make note of the identifier in the URL: `https://repology.org/repository/<identifier>`
A [list of all supported repositories](https://repology.org/repositories/statistics) can be found on the Repology homepage. To determine the correct identifier, select the repository of your choice and make note of the identifier in the URL: `https://repology.org/repository/<identifier>`

As an example, the `Alpine Linux 3.12` repository points to `https://repology.org/repository/alpine_3_12` and therefor has the repository identifier `alpine_3_12`.

Expand Down

0 comments on commit a49e206

Please sign in to comment.