From f72fb854bed913753f2387116145df34c9505bf8 Mon Sep 17 00:00:00 2001
From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Date: Sun, 29 Nov 2020 17:00:16 +0100
Subject: [PATCH] docs: improve Node.js documentation (#7822)
* split up long sentence
* use active voice
* use 1's for ordered list, fix whitespace
* split sentence, and rewrite in active voice
* Implement review suggestion
Co-authored-by: Rhys Arkins <rhys@arkins.net>
Co-authored-by: Rhys Arkins <rhys@arkins.net>
---
docs/usage/node.md | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/docs/usage/node.md b/docs/usage/node.md
index 22e2abbcee..08c41a6acd 100644
--- a/docs/usage/node.md
+++ b/docs/usage/node.md
@@ -5,11 +5,12 @@ description: Node.js versions support in Renovate
# Node.js Versions
-Renovate can upgrade the [Node.js](https://nodejs.org/en/) runtime used by your project so that you're using the latest bug fixes, performance improvements, security mitigations, etc. that meet your project's unique needs.
+Renovate can upgrade the [Node.js](https://nodejs.org/en/) runtime used by your project.
+This way you're using the latest bug fixes, performance improvements, security mitigations, etc.
## File Support
-Renovate is capable of managing the Node.js version in the following files:
+Renovate can manage the Node.js version in the following files:
- The [`engines`](https://docs.npmjs.com/files/package.json#engines) field in [`package.json`](https://docs.npmjs.com/files/package.json)
- The [`volta`](https://docs.volta.sh/guide/understanding#managing-your-project) field in [`package.json`](https://docs.npmjs.com/files/package.json)
@@ -22,8 +23,8 @@ Node.js renovation in `package.json > engines` and in `.nvmrc` is enabled by def
To enable `.travis.yml` renovation, you must:
-1. Enable Travis renovation explicitly by setting the following Renovate configuration: `"travis": { "enabled": true }`
-2. Optionally, configure a support policy (As documented below)
+1. Enable Travis renovation explicitly by setting the following Renovate configuration: `"travis": { "enabled": true }`
+1. Optionally, configure a support policy (As documented below)
When Renovate processes your project's repository it will look for the files listed above and submit a single pull request that upgrades all Node.js versions simultaneously.
@@ -50,6 +51,7 @@ For example, to instruct Renovate to upgrade your project to the latest [Long-te
"supportPolicy": ["lts_latest"]
```
-It's best to define this support policy inside the `node` configuration object so that it is applied to all Node.js-related files.
+We recommend that you define this support policy inside the `node` configuration object.
+This way, it is applied to all Node.js-related files.
For additional language support see the [`supportPolicy` documentation](/configuration-options/#supportpolicy).
--
GitLab