From 76c9c63417d72e38dac7d00040c33186f9df4dad Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Tue, 22 Aug 2023 14:07:21 +0200 Subject: [PATCH] docs: use simple words (#23989) --- .github/contributing.md | 4 ++-- docs/development/help-us-help-you.md | 2 +- docs/development/local-development.md | 4 ++-- docs/usage/bazel.md | 2 +- docs/usage/config-presets.md | 2 +- docs/usage/configuration-options.md | 12 ++++++------ docs/usage/dependency-pinning.md | 2 +- docs/usage/docker.md | 2 +- docs/usage/examples/self-hosting.md | 4 ++-- docs/usage/getting-started/installing-onboarding.md | 2 +- docs/usage/getting-started/running.md | 2 +- docs/usage/golang.md | 2 +- docs/usage/java.md | 2 +- docs/usage/noise-reduction.md | 2 +- docs/usage/nuget.md | 2 +- docs/usage/ruby.md | 2 +- docs/usage/rust.md | 2 +- docs/usage/self-hosted-configuration.md | 8 ++++---- docs/usage/templates.md | 2 +- lib/config/options/index.ts | 4 ++-- lib/modules/datasource/endoflife-date/readme.md | 2 +- lib/modules/datasource/repology/index.ts | 2 +- lib/modules/manager/cocoapods/readme.md | 3 ++- lib/modules/manager/pip_requirements/readme.md | 3 ++- lib/modules/platform/gitea/index.ts | 4 ++-- lib/util/github/graphql/readme.md | 2 +- lib/workers/global/config/parse/file.ts | 2 +- 27 files changed, 42 insertions(+), 40 deletions(-) diff --git a/.github/contributing.md b/.github/contributing.md index e675340604..59d1107c4b 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -59,8 +59,8 @@ Read the [GitHub docs, Applying suggested changes](https://docs.github.com/en/pu ## Resolve review comments instead of commenting -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. +A maintainer/contributor can ask you to make changes, without giving you a _suggestion_ that you can apply. +In this case you should make the necessary changes. 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". diff --git a/docs/development/help-us-help-you.md b/docs/development/help-us-help-you.md index 3dd587557a..9aaea3862a 100644 --- a/docs/development/help-us-help-you.md +++ b/docs/development/help-us-help-you.md @@ -46,7 +46,7 @@ If you feel frustrated because better documentation would have prevented you fro ## Avoid spamming issues 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. +Such comments appear intended to "pressure" Renovate maintainers into taking notice, and rarely do they help the people subscribed to the other, mostly-unrelated issues. Please do not do it. Instead, use the "Subscribe" button to follow issues. diff --git a/docs/development/local-development.md b/docs/development/local-development.md index 9ca7d8c9eb..c9874fbcde 100644 --- a/docs/development/local-development.md +++ b/docs/development/local-development.md @@ -58,7 +58,7 @@ If you are using [VS Code](https://code.visualstudio.com/) you can skip installi - Open the repository folder in VS Code - Choose "Reopen in Container" via the command palette or the small button in the lower left corner -The VS Code [integrated terminal](https://code.visualstudio.com/docs/editor/integrated-terminal) is now running in the container and can be used to run additional commands. +The VS Code [integrated terminal](https://code.visualstudio.com/docs/editor/integrated-terminal) is now running in the container and can be used to run more commands. To build inside the container: @@ -150,7 +150,7 @@ e.g. `pnpm jest composer -u` would update the saved snapshots for _all_ tests in ### Coverage The Renovate project maintains 100% test coverage, so any Pull Request will fail if it does not have full coverage for code. -Using `// istanbul ignore` is not ideal but sometimes is a pragmatic solution if an additional test wouldn't really prove anything. +Using `// istanbul ignore` is not ideal, but can be a pragmatic solution if adding more tests wouldn't really prove anything. To view the current test coverage locally, open up `coverage/index.html` in your browser. diff --git a/docs/usage/bazel.md b/docs/usage/bazel.md index 000f0688f0..8eec08f4e1 100644 --- a/docs/usage/bazel.md +++ b/docs/usage/bazel.md @@ -222,4 +222,4 @@ To change it, configure `packageRules` like this: ## Future work -Contributions and/or feature requests are welcome to support more patterns or additional use cases. +We welcome contributions or feature requests to support more patterns or use cases. diff --git a/docs/usage/config-presets.md b/docs/usage/config-presets.md index 7322f49810..4281104237 100644 --- a/docs/usage/config-presets.md +++ b/docs/usage/config-presets.md @@ -210,7 +210,7 @@ Renovate will determine the current platform and look up the preset from there. ## Contributing to presets -Have you configured a rule that you think others might benefit from? +Have you configured a rule that could help others? Please consider contributing it to the [Renovate repository](https://github.com/renovatebot/renovate/tree/main/lib/config/presets/internal) so that it gains higher visibility and saves others from reinventing the same thing. Create a [discussion](https://github.com/renovatebot/renovate/discussions) to propose your preset to the Renovate maintainers. diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 777ceb4b77..e87da7b3cd 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -151,7 +151,7 @@ FROM java:8@sha256:0e8b2a860 With the above replacement scenario, the current dependency has a version of `8`, which also features several times within the digest section. -When using the default `autoReplaceGlobalMatch` configuration, Renovate will attempt to replace all instances of `8` within the dependency string with the `replacementVersion` value of `11`. +When using the default `autoReplaceGlobalMatch` configuration, Renovate will try to replace all instances of `8` within the dependency string with the `replacementVersion` value of `11`. This will replace more than is intended and will be caught during replacement validation steps, resulting in the replacement PR to not be created. When setting `autoReplaceGlobalMatch` configuration to `false`, Renovate will only replace the first occurrence of `8` and will successfully create a replacement PR. @@ -537,7 +537,7 @@ If enabled, Renovate raises a pull request when it needs to migrate the Renovate Renovate only performs `configMigration` on `.json` and `.json5` files. We're adding new features to Renovate bot often. -Often you can keep using your Renovate config and benefit from the new features right away. +Often you can keep using your Renovate config and use the new features right away. But sometimes you need to update your Renovate configuration. To help you with this, Renovate will create config migration pull requests, when you enable `configMigration`. @@ -1075,11 +1075,11 @@ Use `forkModeDisallowMaintainerEdits` to disallow maintainers from editing Renov If GitHub pull requests are created from a [fork repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo), the PR author can decide to allow upstream repository to modify the PR directly. -Allowing maintainers to edit pull requests directly is helpful when Renovate pull requests require additional changes. +Allowing maintainers to edit pull requests directly is helpful when Renovate pull requests require more changes. The reviewer can simply push to the pull request without having to create a new PR. [More details here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork). You may decide to disallow edits to Renovate pull requests in order to workaround issues in Renovate where modified fork branches are not deleted properly: [See this issue](https://github.com/renovatebot/renovate/issues/16657). -If this option is enabled, reviewers will need to create a new PR if additional changes are needed. +If this option is enabled, reviewers will need to create a new PR if more changes are needed. <!-- prettier-ignore --> !!! note @@ -2661,7 +2661,7 @@ Table with options: Post-upgrade tasks can only be used on self-hosted Renovate instances. Post-upgrade tasks are commands that are executed by Renovate after a dependency has been updated but before the commit is created. -The intention is to run any additional command line tools that would modify existing files or generate new files when a dependency changes. +The intention is to run any other command line tools that would modify existing files or generate new files when a dependency changes. Each command must match at least one of the patterns defined in `allowedPostUpgradeCommands` (a global-only configuration option) in order to be executed. If the list of allowed tasks is empty then no tasks will be executed. @@ -3379,7 +3379,7 @@ The default value for `schedule` is "at any time", which is functionally the sam i.e. Renovate will run on the repository around the clock. The easiest way to define a schedule is to use a preset if one of them fits your requirements. -See [Schedule presets](https://docs.renovatebot.com/presets-schedule/) for details and feel free to request a new one in the source repository if you think others would benefit from it too. +See [Schedule presets](https://docs.renovatebot.com/presets-schedule/) for details and feel free to request a new one in the source repository if you think it would help others. Otherwise, here are some text schedules that are known to work: diff --git a/docs/usage/dependency-pinning.md b/docs/usage/dependency-pinning.md index 997e464330..14a569a7b5 100644 --- a/docs/usage/dependency-pinning.md +++ b/docs/usage/dependency-pinning.md @@ -128,7 +128,7 @@ And worse still, npm package versions that are less than 24 hours [can be unpubl So to reduce the interruptions of automated dependency updates, consider putting Renovate on a schedule, such as: - Update only on weekends? This way you update packages at most once per week, _and_ your CI build runners are likely to be idle anyway -- Update daily, but between hours like midnight and 5am? That way notifications don't pop up in people's feed while they're working, _and_ you also get the benefit of not tying up build machines when developers need to use them +- Update daily, but between midnight and 5am? This way developers aren't bothered by notifications when they're working, _and_ you're keeping the build machines free for the developers To learn all about controlling Renovate's schedule, read the [key concepts, scheduling](./key-concepts/scheduling.md) docs. diff --git a/docs/usage/docker.md b/docs/usage/docker.md index 7149f3cb46..236fd55df1 100644 --- a/docs/usage/docker.md +++ b/docs/usage/docker.md @@ -214,7 +214,7 @@ module.exports = { }; ``` -You can add additional host rules, read the [`hostRules` documentation](./configuration-options.md#hostrules) for more information. +You can add more host rules, read the [`hostRules` documentation](./configuration-options.md#hostrules) for more information. #### Self-hosted Docker registry diff --git a/docs/usage/examples/self-hosting.md b/docs/usage/examples/self-hosting.md index 8d52d603ba..86d87344b8 100644 --- a/docs/usage/examples/self-hosting.md +++ b/docs/usage/examples/self-hosting.md @@ -77,7 +77,7 @@ spec: restartPolicy: Never ``` -And also this accompanying `secret.yaml`: +And the `secret.yaml` that goes with it: ```yaml apiVersion: v1 @@ -411,7 +411,7 @@ The logging level output is controlled by the Bunyan logging library. ## Self-signed TLS/SSL certificates Renovate and invoked helper programs (like Git, or npm) use a secure TLS connection (e.g. HTTPS) to connect to remote source code and dependency hosts. -If the remote hosts use any self-signed certificates or certificate authorities then Renovate needs to be told to trust these additional certificates. +If the remote hosts uses self-signed certificates or certificate authorities then Renovate must be told to trust them. ### Renovate Node.js app diff --git a/docs/usage/getting-started/installing-onboarding.md b/docs/usage/getting-started/installing-onboarding.md index 7b4cf08d1c..aa0162d192 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 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. +If the administrator has configured a fixed list of repositories then the only way to "install" Renovate on a extra 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: diff --git a/docs/usage/getting-started/running.md b/docs/usage/getting-started/running.md index c8bc0d0ad2..d44fc37f20 100644 --- a/docs/usage/getting-started/running.md +++ b/docs/usage/getting-started/running.md @@ -131,7 +131,7 @@ For the npm package approach or Docker images, you will need some form of VM or In all the above cases you must make sure that some form of cron-like capability exists to schedule when Renovate runs. We recommend that you run Renovate hourly, if possible. -Mend Renovate On-Premises and Mend Remediate both run as long-lived containers, so they do not need any additional cron-like concept as it is built-in. +Mend Renovate On-Premises and Mend Remediate both run as long-lived containers, so they do not need any cron-like concept as it is built-in. ### Global config diff --git a/docs/usage/golang.md b/docs/usage/golang.md index d9edec8e71..0b94284f8b 100644 --- a/docs/usage/golang.md +++ b/docs/usage/golang.md @@ -5,7 +5,7 @@ description: Go modules support in Renovate # Automated Dependency Updates for Go Modules -Renovate supports upgrading dependencies in `go.mod` files and their accompanying `go.sum` checksums. +Renovate supports upgrading dependencies in `go.mod` files and associated `go.sum` checksums. If you're self-hosting Renovate, you may use these environment variables: diff --git a/docs/usage/java.md b/docs/usage/java.md index 6f3b4624af..8d1720771f 100644 --- a/docs/usage/java.md +++ b/docs/usage/java.md @@ -101,7 +101,7 @@ Any repository URLs found within will be added as `registryUrls` to extracted de ## Custom registry support, and authentication The manager for Gradle makes use of the `maven` datasource. -Renovate can be configured to access additional repositories and access repositories authenticated. +Renovate can be configured to access more repositories and access repositories authenticated. This example shows how you can use a `config.js` file to configure Renovate for use with Artifactory. We're using environment variables to pass the Artifactory username and password to Renovate bot. diff --git a/docs/usage/noise-reduction.md b/docs/usage/noise-reduction.md index 8f267c48a8..9370288129 100644 --- a/docs/usage/noise-reduction.md +++ b/docs/usage/noise-reduction.md @@ -175,7 +175,7 @@ Let's automerge it if all the linting updates pass: } ``` -Have you come up with a rule that you think others would benefit from? +Have you come up with a rule that would help others? How about a PR to [our presets](https://github.com/renovatebot/renovate/tree/main/lib/config/presets/internal)? For example the above rule could be named `":automergeEslintWeekly"` in `schedule.ts`. diff --git a/docs/usage/nuget.md b/docs/usage/nuget.md index 555eec51e6..26c954ef22 100644 --- a/docs/usage/nuget.md +++ b/docs/usage/nuget.md @@ -116,4 +116,4 @@ If you're using Azure DevOps, you can set `matchHost` to `pkgs.dev.azure.com`. ## Future work -Contributions and/or feature requests are welcome to support more patterns or additional use cases. +We welcome contributions or feature requests to support more patterns or use cases. diff --git a/docs/usage/ruby.md b/docs/usage/ruby.md index 249b523569..133d8d5dc5 100644 --- a/docs/usage/ruby.md +++ b/docs/usage/ruby.md @@ -5,7 +5,7 @@ description: Ruby Bundler support in Renovate # Automated dependency updates for Ruby Bundler dependencies -Renovate supports upgrading dependencies in Bundler's Gemfiles and their accompanying `Gemfile.lock` files. +Renovate supports upgrading dependencies in Bundler's Gemfiles and associated `Gemfile.lock` files. ## How it works diff --git a/docs/usage/rust.md b/docs/usage/rust.md index 45365bbfa4..53813f288d 100644 --- a/docs/usage/rust.md +++ b/docs/usage/rust.md @@ -5,7 +5,7 @@ description: Rust crates support in Renovate # Automated Dependency Updates for Rust crates -Renovate supports upgrading dependencies in `Cargo.toml` files and their accompanying `Cargo.lock` checksums. +Renovate supports upgrading dependencies in `Cargo.toml` files and associated `Cargo.lock` checksums. ## How it works diff --git a/docs/usage/self-hosted-configuration.md b/docs/usage/self-hosted-configuration.md index a4dc8516a9..62fa38ef7d 100644 --- a/docs/usage/self-hosted-configuration.md +++ b/docs/usage/self-hosted-configuration.md @@ -572,14 +572,14 @@ Similarly to `onboardingBranch`, if you have an existing Renovate installation a When this option is `true`, Renovate will do the following during repository initialization: -- Attempt to fetch the default config file (`renovate.json`) +- Try to fetch the default config file (`renovate.json`) - Check if the file contains `"enabled": false` If the file exists and the config is disabled, Renovate will skip the repo without cloning it. Otherwise, it will continue as normal. This option is only useful where the ratio of disabled repos is quite high. -It costs one extra API call per repo but has the benefit of skipping cloning of those which are disabled. +You spend one extra API call per repo, but skip cloning disabled repositories. ## password @@ -706,7 +706,7 @@ Example URL structure: `redis://[[username]:[password]]@localhost:6379/0`. ## repositories -Elements in the `repositories` array can be an object if you wish to define additional settings: +Elements in the `repositories` array can be an object if you wish to define more settings: ```js { @@ -732,7 +732,7 @@ Set this to an S3 URI to enable S3 backed repository cache. <!-- prettier-ignore --> !!! note - [IAM is supported](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-iam.html) when running renovate within an EC2 instance in an ECS cluster. In this case, no additional environment variables are required. + [IAM is supported](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-iam.html) when running Renovate within an EC2 instance in an ECS cluster. In this case, no extra environment variables are required. Otherwise, the following environment variables should be set for the S3 client to work. ``` diff --git a/docs/usage/templates.md b/docs/usage/templates.md index dcfbab9851..318a416169 100644 --- a/docs/usage/templates.md +++ b/docs/usage/templates.md @@ -109,6 +109,6 @@ This is for security reasons. `HOME is {{env.HOME}}` -If you're self-hosting Renovate, you can expose additional variables with the [`customEnvVariables`](./self-hosted-configuration.md#customenvvariables) config option. +If you're self-hosting Renovate, you can expose more variables with the [`customEnvVariables`](./self-hosted-configuration.md#customenvvariables) config option. You can also use the [`exposeAllEnv`](./self-hosted-configuration.md#exposeallenv) config option to allow all environment variables in templates, but make sure to consider the security implications of giving the scripts unrestricted access to all variables. diff --git a/lib/config/options/index.ts b/lib/config/options/index.ts index 60f7c4c8c5..e461072556 100644 --- a/lib/config/options/index.ts +++ b/lib/config/options/index.ts @@ -859,7 +859,7 @@ const options: RenovateOptions[] = [ { name: 'gitIgnoredAuthors', description: - 'Additional Git authors which are ignored by Renovate. Must conform to [RFC5322](https://datatracker.ietf.org/doc/html/rfc5322).', + 'Git authors which are ignored by Renovate. Must conform to [RFC5322](https://datatracker.ietf.org/doc/html/rfc5322).', type: 'array', subType: 'string', stage: 'repository', @@ -2394,7 +2394,7 @@ const options: RenovateOptions[] = [ { name: 'prBodyNotes', description: - 'List of additional notes/templates to include in the Pull Request body.', + 'List of extra notes or templates to include in the Pull Request body.', type: 'array', subType: 'string', default: [], diff --git a/lib/modules/datasource/endoflife-date/readme.md b/lib/modules/datasource/endoflife-date/readme.md index 0c79625572..36cec9fd13 100644 --- a/lib/modules/datasource/endoflife-date/readme.md +++ b/lib/modules/datasource/endoflife-date/readme.md @@ -1,6 +1,6 @@ [endoflife.date](https://endoflife.date) provides version and end-of-life information for different packages. -To find the appropriate "package" name for the software you're trying to update, use the endoflife.date "All packages" API endpoint. +To find the right "package" name for the software you're trying to update, use the endoflife.date "All packages" API endpoint. You can find it in [the endoflife.date API documentation](https://endoflife.date/docs/api). By default, this datasource uses `loose` versioning. diff --git a/lib/modules/datasource/repology/index.ts b/lib/modules/datasource/repology/index.ts index b9da4c06c4..b07e76b21d 100644 --- a/lib/modules/datasource/repology/index.ts +++ b/lib/modules/datasource/repology/index.ts @@ -205,7 +205,7 @@ export class RepologyDatasource extends Datasource { logger.trace(`repology.getReleases(${repoName}, ${pkgName})`); try { - // Attempt to retrieve (cached) package information from Repology + // Try to retrieve (cached) package information from Repology const pkg = await this.queryPackage(registryUrl, repoName, pkgName); if (!pkg) { return null; diff --git a/lib/modules/manager/cocoapods/readme.md b/lib/modules/manager/cocoapods/readme.md index 56f30f94e6..c412c0d5ec 100644 --- a/lib/modules/manager/cocoapods/readme.md +++ b/lib/modules/manager/cocoapods/readme.md @@ -1,3 +1,4 @@ The `cocoapods` manager supports extracting both "pod" type references as well as dependencies on GitHub repositories that use versioned tags. -Whenever a `Podfile` is updated, Renovate will also update any accompanying `Podfile.lock` file. This is done using the `cocoapods` gem which runs within the Ruby runtime. +Whenever a `Podfile` is updated, Renovate will also update any associated `Podfile.lock` file. +This is done using the `cocoapods` gem, which runs within the Ruby runtime. diff --git a/lib/modules/manager/pip_requirements/readme.md b/lib/modules/manager/pip_requirements/readme.md index 5c89d80660..200813c1c6 100644 --- a/lib/modules/manager/pip_requirements/readme.md +++ b/lib/modules/manager/pip_requirements/readme.md @@ -1 +1,2 @@ -Supports `requirements.txt` and `requirements.pip` files. The default file pattern is fairly flexible in an attempt to catch similarly named ones too (eg `requirements-*.txt` and `requirements-*.pip`) but may be extended/changed. +Supports `requirements.txt` and `requirements.pip` files. +The default file pattern is fairly flexible, to try to catch similarly named ones too (eg `requirements-*.txt` and `requirements-*.pip`) but may be extended/changed. diff --git a/lib/modules/platform/gitea/index.ts b/lib/modules/platform/gitea/index.ts index 55ce4fefaf..79e80177f1 100644 --- a/lib/modules/platform/gitea/index.ts +++ b/lib/modules/platform/gitea/index.ts @@ -271,7 +271,7 @@ const platform: Platform = { config.repository = repository; config.cloneSubmodules = !!cloneSubmodules; - // Attempt to fetch information about repository + // Try to fetch information about repository try { repo = await helper.getRepo(repository); } catch (err) { @@ -909,7 +909,7 @@ const platform: Platform = { return; } - // Attempt to delete comment + // Try to delete comment try { await helper.deleteComment(config.repository, comment.id); } catch (err) { diff --git a/lib/util/github/graphql/readme.md b/lib/util/github/graphql/readme.md index 6a094e4cbf..c775afd6bb 100644 --- a/lib/util/github/graphql/readme.md +++ b/lib/util/github/graphql/readme.md @@ -36,7 +36,7 @@ It is responsible for handling several aspects of the fetch process, including: - Handling and aggregating errors that may occur during the fetch process - Dynamically adjusting the page size and retrying in the event of server errors - Enforcing a maximum limit on the number of queries that can be made -- Detecting whether a package is private or public, and selecting the appropriate cache strategy (in-memory or long-term) accordingly +- Detecting whether a package is private or public, and selecting the right cache strategy (in-memory or long-term) accordingly - Ensuring proper concurrency when querying the same package simultaneously. The `cache-strategies/` directory is responsible for caching implementation. diff --git a/lib/workers/global/config/parse/file.ts b/lib/workers/global/config/parse/file.ts index ba255ecd10..5a66827ace 100644 --- a/lib/workers/global/config/parse/file.ts +++ b/lib/workers/global/config/parse/file.ts @@ -72,7 +72,7 @@ export async function getConfig(env: NodeJS.ProcessEnv): Promise<AllConfig> { } } - await deleteNonDefaultConfig(env); // Attempt deletion only if RENOVATE_CONFIG_FILE is specified + await deleteNonDefaultConfig(env); // Try deletion only if RENOVATE_CONFIG_FILE is specified const { isMigrated, migratedConfig } = migrateConfig(config); if (isMigrated) { -- GitLab