From 76ba198e72b6012e34b9eddd263448e44f4789e9 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Fri, 23 Oct 2020 15:30:15 +0200 Subject: [PATCH] docs: use proper capitalization for noun JavaScript (#7528) --- docs/usage/configure-renovate.md | 2 +- docs/usage/dependency-pinning.md | 6 +++--- docs/usage/docker.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/usage/configure-renovate.md b/docs/usage/configure-renovate.md index 2de6913cb0..53190a3cbf 100644 --- a/docs/usage/configure-renovate.md +++ b/docs/usage/configure-renovate.md @@ -21,7 +21,7 @@ If you have any Warnings or Errors listed, see if you need or want to make any c The Configure Renovate PR will include a `renovate.json` file in the root directory, with suggested default settings. -If you don't want to have an additional file (`renovate.json`) in your repository then you can instead add the same settings to a `"renovate"` section in your `package.json`, if you are already using this (e.g. javascript project). Any settings made in `package.json` will apply to the whole project (including other, nested `package.json` files). +If you don't want to have an additional file (`renovate.json`) in your repository then you can instead add the same settings to a `"renovate"` section in your `package.json`, if you are already using this (e.g. JavaScript project). Any settings made in `package.json` will apply to the whole project (including other, nested `package.json` files). Alternatively, if you prefer to use "dot files" then you can add the same JSON configuration to either a `.renovaterc` file or `.renovaterc.json` file instead of `renovate.json`. diff --git a/docs/usage/dependency-pinning.md b/docs/usage/dependency-pinning.md index 0a0c34c46e..ba85cad542 100644 --- a/docs/usage/dependency-pinning.md +++ b/docs/usage/dependency-pinning.md @@ -1,9 +1,9 @@ --- -title: Should you Pin your Javascript Dependencies? -description: The pros and cons of dependency pinning for Javascript/npm +title: Should you Pin your JavaScript Dependencies? +description: The pros and cons of dependency pinning for JavaScript/npm --- -# Should you Pin your Javascript Dependencies? +# Should you Pin your JavaScript Dependencies? Once you start using a tool/service like Renovate, probably the biggest decision you need to make is whether to "pin" your dependencies instead of using semver ranges. The answer is "It's your choice", however we can certainly make some generalisations/recommendations to help you. Jump to the bottom conclusions if you get impatient. diff --git a/docs/usage/docker.md b/docs/usage/docker.md index ea2875091f..fefcc6f3d3 100644 --- a/docs/usage/docker.md +++ b/docs/usage/docker.md @@ -63,7 +63,7 @@ Finally, if you use a Docker image that follows a versioning approach not captur Pinning your docker images to an exact digest is recommended for reasons of **immutability**. In short: pin to digests so every time you `pull`, you get the same content. -If your experience with dependency versioning comes from a place like javascript/npm, you might be used to exact versions being immutable, e.g. if you specify a version like `2.0.1` then you and your colleagues will always get the exact same "code". What you may not expect is that Docker's tags are not immutable versions even if they look like a version. e.g. you probably expect that `node:8` and `node:8.9` will change over time, but you might incorrectly assume that `node:8.9.0` would never change. Although it probably _shouldn't_, the reality is that any Docker image tag _can_ change content, and potentially break. +If your experience with dependency versioning comes from a place like JavaScript/npm, you might be used to exact versions being immutable, e.g. if you specify a version like `2.0.1` then you and your colleagues will always get the exact same "code". What you may not expect is that Docker's tags are not immutable versions even if they look like a version. e.g. you probably expect that `node:8` and `node:8.9` will change over time, but you might incorrectly assume that `node:8.9.0` would never change. Although it probably _shouldn't_, the reality is that any Docker image tag _can_ change content, and potentially break. Using a docker digest as the image's primary identifier instead of docker tag will achieve immutability but as a human it's quite inconvenient to deal with strings like `FROM node@sha256:552348163f074034ae75643c01e0ba301af936a898d778bb4fc16062917d0430`. The good news is that, as a human you no longer need to manually update such digests once you have Renovate on the job. -- GitLab