diff --git a/docs/development/triage-guide.md b/docs/development/triage-guide.md index 796863a58c4dcbf8965930034668c23a00c2ecc0..d64f90283daff160d2e6e310dfbb64be9ec744ab 100644 --- a/docs/development/triage-guide.md +++ b/docs/development/triage-guide.md @@ -32,7 +32,7 @@ In general try to make a good-faith effort to label things correctly. ### Closing issues -You can close a issue yourself if it's: +You can close an issue yourself if it's: - Spam - Obviously fixed @@ -45,7 +45,7 @@ It's not very often that you'll need to close a PR, but you can certainly do it ### Reopen issues -Sometimes a bug is fixed with a PR that links to a issue. +Sometimes a bug is fixed with a PR that links to an issue. When the PR is merged, the issue is automatically closed. Sometimes the bug was not really fixed, and someone says: "Hey this is still broken for me." In that case, re-open the issue only if it's definitely the same problem (users often associate different problems together incorrectly). @@ -53,7 +53,7 @@ Otherwise, ask the user to open a new issue if it seems like it is different. ### Assign issues -You can assign a issue to yourself, so that others know you're going to work on the issue. +You can assign an issue to yourself, so that others know you're going to work on the issue. GitHub allows issues to be assigned to any project collaborator or to any non-collaborator who has created or commented on the issue, so you can also assign in either of those cases if it makes sense. ### Mark duplicate issues and pull requests @@ -77,8 +77,8 @@ In those cases you can lock the discussion to prevent further escalation. ### Individually convert issues to discussions -Sometimes a issue that's raised at the Renovate repository is not really a bug or a feature request. -This happens most often because a user files a bug for things that are really a misstake in the Renovate configuration. +Sometimes an issue that's raised at the Renovate repository is not really a bug or a feature request. +This happens most often because a user files a bug for things that are really a mistake in the Renovate configuration. Those "configuration help" issues are then moved to the discussions board for further help. ### Moving issues from `status:requirements` to `status:ready` diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 75e6dc50fee59bdbeed73b4dfcd30ea43c71d198..4b5cc2992b5e43ae7f3896dac5f115e9c5b4a234 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -433,7 +433,7 @@ This feature allows you to use Renovate's Dependency Dashboard to force approval 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. -Note: When you set `dependencyDashboardApproval` to `true` the Dependency Dashboard issue will be created automatically, you do not need to turn on `dependencyDashboard` explictly. +Note: When you set `dependencyDashboardApproval` to `true` the Dependency Dashboard issue will be created automatically, you do not need to turn on `dependencyDashboard` explicitly. You can configure Renovate to wait for approval for: diff --git a/docs/usage/faq.md b/docs/usage/faq.md index 2b00055398c348aa0b8cf9e458fbb24a3f4441bd..69d3e1c9f647d9ad0c79339438271e6c18df6adc 100644 --- a/docs/usage/faq.md +++ b/docs/usage/faq.md @@ -46,7 +46,7 @@ If you're self hosting Renovate, use the latest release if possible. | Dependency Dashboard | BitBucket, BitBucket Server, Azure | [#9592](https://github.com/renovatebot/renovate/issues/9592) | | Hosted app | GitLab, BitBucket, BitBucket Server, Azure, Gitea | | -## Major platform features not suported by Renovate +## Major platform features not supported by Renovate Some major platform features are not supported at all by Renovate. diff --git a/docs/usage/getting-started/installing-onboarding.md b/docs/usage/getting-started/installing-onboarding.md index d1140626559e010afbd4a818d18cda75211a7206..c60116ad5e645d68f8a13a56089404cc42c1ce8b 100644 --- a/docs/usage/getting-started/installing-onboarding.md +++ b/docs/usage/getting-started/installing-onboarding.md @@ -4,7 +4,7 @@ Renovate administrators can configure Renovate to either "autodiscover" installed repositories, or configure a fixed list of repository names to operate on. -If the adminstrator has configured a fixed list of repositories then the only way to "install" Renovate on an additional repository is for it to be manually added for the next run or restart. +If the administrator has configured a fixed list of repositories then the only way to "install" Renovate on an additional repository is for it to be manually added for the next run or restart. Otherwise, the process for adding new repositories to a Renovate installation can vary: @@ -81,7 +81,7 @@ The configuration in your `package.json` will apply to the whole project (this i ### Customised defaults Renovate provides a `renovate.json` file, with default settings that will work for most cases. -Sometimes Renovate detects that a override to these defaults is needed, and will add this override automatically, such as: +Sometimes Renovate detects that an override to these defaults is needed, and will add this override automatically, such as: - Automatically enabling Angular-style semantic commits if your repository uses them - Determining whether to use dependency range pinning depending on the detected project type (app vs library) diff --git a/docs/usage/getting-started/private-packages.md b/docs/usage/getting-started/private-packages.md index 1cf71858927c5aa28285fc69bce49924252bb952..36db3a72ea29964825c0228198c0791add588cbc 100644 --- a/docs/usage/getting-started/private-packages.md +++ b/docs/usage/getting-started/private-packages.md @@ -96,7 +96,7 @@ It can be confusing for people who host their own source code privately to be as Currently the preferred way to configure `github.com` credentials for self-hosted Renovate is: -- Create a read-only Personal Access Token (PAT) for a `github.com` account. This can be any GitHub account, it might be better to create a "empty" account just for this purpose. +- Create a read-only Personal Access Token (PAT) for a `github.com` account. This can be any GitHub account, it might be better to create an "empty" account just for this purpose. - Add the PAT to Renovate using the environment variable `GITHUB_COM_TOKEN` ## Package Manager Credentials for Artifact Updating diff --git a/docs/usage/getting-started/running.md b/docs/usage/getting-started/running.md index 425d0e7e358761c2a938cc7670e329ee3a82a414..9831beb5f65b982be05a5f5091a56652b0bdfb1a 100644 --- a/docs/usage/getting-started/running.md +++ b/docs/usage/getting-started/running.md @@ -64,7 +64,7 @@ It is built similarly to the "full" Renovate image described above, but with the - It is installed as an App on GitHub, and behaves similarly on GitLab - for example responding to webhooks - It includes a priority job queue which prioritizes events like merged PRs over scheduled jobs - It is released every 1-2 months in a slower, more stable cadence than Renovate OSS, which releases on every commit -- It's licensed using a end-user license agreement (EULA) and not the Affero General Public License (AGPL) +- It's licensed using an end-user license agreement (EULA) and not the Affero General Public License (AGPL) WSOP supports GitHub (both `github.com` and GitHub Enterprise Server) as well as GitLab self-hosted. Documentation can be found in its public GitHub repository [`whitesource/renovate-on-prem`](https://github.com/whitesource/renovate-on-prem). @@ -191,7 +191,7 @@ Don't forget to configure `platform=azure` somewhere in config. #### Gitea -First, [create a access token](https://docs.gitea.io/en-us/api-usage/#authentication-via-the-api) for your bot account. +First, [create an access token](https://docs.gitea.io/en-us/api-usage/#authentication-via-the-api) for your bot account. Configure it as `token` in your `config.js` file, or in environment variable `RENOVATE_TOKEN`, or via CLI `--token=`. Don't forget to configure `platform=gitea` somewhere in config. diff --git a/docs/usage/golang.md b/docs/usage/golang.md index 1fd2a25131eab52edd045bfc5f478f4c11fd6fbb..e724dbec3a95a01b1462e3fabc3f07f9a2a4b798 100644 --- a/docs/usage/golang.md +++ b/docs/usage/golang.md @@ -52,4 +52,4 @@ As an example, say you want Renovate to use the latest patch version of the `1.1 ``` We do not support patch level versions for the minimum `go` version. -This means you cannot use `go 1.16.6`, but you can use `go 1.16` as a contraint. +This means you cannot use `go 1.16.6`, but you can use `go 1.16` as a constraint. diff --git a/docs/usage/key-concepts/dashboard.md b/docs/usage/key-concepts/dashboard.md index 0994fca5e416881cf2b562c06c8c340c4487da61..c9c2b1252008b063cc096474264be63a8e8ad1da 100644 --- a/docs/usage/key-concepts/dashboard.md +++ b/docs/usage/key-concepts/dashboard.md @@ -5,10 +5,10 @@ description: Learn all about Renovate's Dependency Dashboard # Introduction -Renovate has a Dependency Dashboard that shows a overview of the state of your repositories' dependencies. +Renovate has a Dependency Dashboard that shows an overview of the state of your repositories' dependencies. When the Dependency Dashboard is enabled, Renovate will create a new issue in the repository. -This issue contains a "dashboard" where you can get a overview of the status of all updates. +This issue contains a "dashboard" where you can get an overview of the status of all updates. Having the Dependency Dashboard also enables the concept of an "approval" workflow for new upgrades, either for selected dependencies (recommended) or even for all. @@ -51,14 +51,14 @@ This section explains some common use cases where having the Dependency Dashboar ### Visibility into rejected/deferred updates -Renovate's Dependency Dashboard shows a overview of all updates that are still "to do". +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. ### Dependency Dashboard Approval workflow -Sometimes you want Renovate to wait for your approval before creating a update PR. +Sometimes you want Renovate to wait for your approval before creating an update PR. You can customize this "wait for approval" behavior however you like best. At a high level the options are: diff --git a/docs/usage/self-hosted-configuration.md b/docs/usage/self-hosted-configuration.md index e46342351fca999f1784d6a6e0a59265a8ff07d0..f48cbf777c22d96c3d1fe609e85ab4ab751d2772 100644 --- a/docs/usage/self-hosted-configuration.md +++ b/docs/usage/self-hosted-configuration.md @@ -418,7 +418,7 @@ It could then be used in a repository config or preset like so: } ``` -Secret names must start with a upper or lower case character and can contain only characters, digits, or underscores. +Secret names must start with an upper or lower case character and can contain only characters, digits, or underscores. ## skipInstalls diff --git a/docs/usage/self-hosted-experimental.md b/docs/usage/self-hosted-experimental.md index 556152ca162a59a287b6d374c2a424d17306230f..23b90e9ca12dc33302431cec51b6c6c142135bf1 100644 --- a/docs/usage/self-hosted-experimental.md +++ b/docs/usage/self-hosted-experimental.md @@ -7,12 +7,12 @@ The following environment variables are "experimental" because: - They can be removed at any time - They are variables for Renovate's internal use to validate they work as intended -Experimental variables which are commonly used and for which there is no external solution in sight can be converted to a official configuration option by the Renovate bot developers. +Experimental variables which are commonly used and for which there is no external solution in sight can be converted to an official configuration option by the Renovate bot developers. Use these experimental variables at your own risk. We do not follow Semantic Versioning for any experimental variables. These variables may be removed or have their behavior changed in **any** version. -We will try to keep breakage to a minimum, but make no guarantees that a experimental variable will keep working. +We will try to keep breakage to a minimum, but make no guarantees that an experimental variable will keep working. ## RENOVATE_CACHE_NPM_MINUTES @@ -21,7 +21,7 @@ If set to any integer, Renovate will use this integer instead of the default npm ## RENOVATE_EXPERIMENTAL_NO_MAVEN_POM_CHECK If set to any value, Renovate will skip its default artifacts filter check in the Maven datasource. -Skiping the check will speed things up, but may result in versions being returned which don't properly exist on the server. +Skipping the check will speed things up, but may result in versions being returned which don't properly exist on the server. ## RENOVATE_PAGINATE_ALL diff --git a/docs/usage/setup-azure-devops.md b/docs/usage/setup-azure-devops.md index 327f475e59545d45ad46b5ebcde6708e39eea4b4..213b3b771336ec464057060505a856c193872b0b 100644 --- a/docs/usage/setup-azure-devops.md +++ b/docs/usage/setup-azure-devops.md @@ -81,7 +81,7 @@ For the `repositories` key, replace `YOUR-PROJECT/YOUR-REPO` with your Azure Dev ### Yarn users -To do a succesfull `yarn install` you need to match the URL of the registry fully. +To do a successful `yarn install` you need to match the URL of the registry fully. Use the `matchHost` config option to specify the full path to the registry. ```javascript