From 23869a629cdfcd35ede43b4ffe6ad3180d292edf Mon Sep 17 00:00:00 2001 From: Rhys Arkins <rhys@arkins.net> Date: Tue, 9 Mar 2021 22:58:00 +0100 Subject: [PATCH] docs: fix $ prefix in docs --- docs/development/configuration.md | 2 +- docs/development/design-decisions.md | 2 +- docs/development/local-development.md | 2 +- docs/usage/self-hosting.md | 14 +++++++------- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/development/configuration.md b/docs/development/configuration.md index 549c44712c..2de6af530c 100644 --- a/docs/development/configuration.md +++ b/docs/development/configuration.md @@ -46,7 +46,7 @@ module.exports = { ### CLI ``` -$ node renovate --help +node renovate --help ``` To configure any `<list>` items, separate with commas. diff --git a/docs/development/design-decisions.md b/docs/development/design-decisions.md index 115488804e..a9c66f6ea2 100644 --- a/docs/development/design-decisions.md +++ b/docs/development/design-decisions.md @@ -90,7 +90,7 @@ String templates (e.g. commit or PR name) are not configurable via CLI options, If you must configure via CLI, use an environment variable instead. e.g. ```sh -$ RENOVATE_BRANCH_NAME=foo renovate +RENOVATE_BRANCH_NAME=foo renovate ``` Alternatively, consider using a Configuration File. diff --git a/docs/development/local-development.md b/docs/development/local-development.md index 902117f78f..c81a6ebe29 100644 --- a/docs/development/local-development.md +++ b/docs/development/local-development.md @@ -185,7 +185,7 @@ It's usually easier to have the logs in a file that you can open with a text edi You can use a command like this to put the log messages in a file: ``` -$ rm -f debug.log && yarn start myaccount/therepo --log-level=debug > debug.log +rm -f debug.log && yarn start myaccount/therepo --log-level=debug > debug.log ``` The example command will delete any existing `debug.log` and then save Renovate's output to a new `debug.log` file. diff --git a/docs/usage/self-hosting.md b/docs/usage/self-hosting.md index 6ba96c1182..6f88383586 100644 --- a/docs/usage/self-hosting.md +++ b/docs/usage/self-hosting.md @@ -5,14 +5,14 @@ ### npmjs ```sh -$ npm install -g renovate +npm install -g renovate ``` Renovate does not embed `npm`, `pnpm` and `yarn` as its own dependencies. If you want to use these package managers to update your lockfiles, you must ensure that the correct versions are already installed globally. ```sh -$ npm install -g yarn pnpm +npm install -g yarn pnpm ``` The same goes for any other third party binary tool like `gradle` or `poetry` - you need to make sure they are installed and the appropriate version before running Renovate. @@ -24,10 +24,10 @@ It builds `latest` based on the `master` branch and all semver tags are publishe For example, all the following are valid tags: ```sh -$ docker run --rm renovate/renovate -$ docker run --rm renovate/renovate:24.53.0 -$ docker run --rm renovate/renovate:24.53 -$ docker run --rm renovate/renovate:24 +docker run --rm renovate/renovate +docker run --rm renovate/renovate:24.53.0 +docker run --rm renovate/renovate:24.53 +docker run --rm renovate/renovate:24 ``` Do not use the example tags listed above, as they will be out-of-date. @@ -37,7 +37,7 @@ If you want to configure Renovate using a `config.js` file then map it to `/usr/ For example: ```sh -$ docker run --rm -v "/path/to/your/config.js:/usr/src/app/config.js" renovate/renovate +docker run --rm -v "/path/to/your/config.js:/usr/src/app/config.js" renovate/renovate ``` ### Kubernetes -- GitLab