From c4e812a2c9c6af09dfa694c46937ece2ae2b9865 Mon Sep 17 00:00:00 2001
From: Rhys Arkins <rhys@arkins.net>
Date: Tue, 27 Aug 2019 13:11:25 +0200
Subject: [PATCH] docs: update docs and app references
---
.github/ISSUE_TEMPLATE/3-Bug_report.md | 4 ++--
docs/configuration.md | 2 +-
docs/readme.md | 2 +-
docs/self-hosting.md | 5 +----
lib/config/app-strings.ts | 2 +-
lib/manager/buildkite/readme.md | 2 +-
lib/manager/bundler/readme.md | 2 +-
lib/manager/cargo/readme.md | 2 +-
lib/manager/cocoapods/readme.md | 2 +-
lib/manager/composer/readme.md | 2 +-
lib/manager/maven/readme.md | 2 +-
lib/manager/poetry/readme.md | 2 +-
lib/manager/pub/readme.md | 2 +-
lib/manager/sbt/readme.md | 2 +-
lib/workers/global/index.js | 17 -----------------
readme.md | 10 +++++-----
website/docs/config-presets.md | 2 +-
website/docs/configuration-options.md | 14 +++++++-------
website/docs/docker.md | 2 +-
website/docs/golang.md | 6 +++---
website/docs/install-gitlab-app.md | 2 +-
website/docs/php.md | 2 +-
website/docs/ruby.md | 2 +-
23 files changed, 35 insertions(+), 55 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/3-Bug_report.md b/.github/ISSUE_TEMPLATE/3-Bug_report.md
index a8d51c3da0..b0d30866a6 100644
--- a/.github/ISSUE_TEMPLATE/3-Bug_report.md
+++ b/.github/ISSUE_TEMPLATE/3-Bug_report.md
@@ -4,13 +4,13 @@ about: You've found a bug with Renovate
---
**What Renovate type are you using?**
-Renovate CLI, Renovate GitHub App, or Renovate Pro?
+Tell us if you're using the hosted App, or if you are self-hosted Renovate yourself. Platform too if you think it's relevant.
**Describe the bug**
A clear and concise description of what the bug is.
**Did you see anything helpful in debug logs?**
-If you are using the Renovate App, log into https://renovatebot.com/dashboard and locate the correct job log for when the problem occurred (e.g. when the PR was created).
+If you are using the Renovate App, log into https://app.renovatebot.com/dashboard and locate the correct job log for when the problem occurred (e.g. when the PR was created).
**To Reproduce**
Steps to reproduce the behavior:
diff --git a/docs/configuration.md b/docs/configuration.md
index 02b7bf9d34..41ce140402 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -70,6 +70,6 @@ any other settings above.
## Configuration Options
-Please see [https://renovatebot.com/docs/configuration-options/](https://renovatebot.com/docs/configuration-options/) for a list of user-facing configuration options.
+Please see [https://docs.renovatebot.com/configuration-options/](https://docs.renovatebot.com/configuration-options/) for a list of user-facing configuration options.
For further options when running your own instance of Renovate, please see the full config definitions file at `lib/config/definitions.js`.
diff --git a/docs/readme.md b/docs/readme.md
index 26afeab963..187ec69c60 100644
--- a/docs/readme.md
+++ b/docs/readme.md
@@ -1,5 +1,5 @@
# Renovate Developer Docs
-This directory is intended to provide documentation for developers/contributors on the Renovate project. For user-facing documentation - e.g. for how to configure Renovate as a user - please see https://renovatebot.com/docs
+This directory is intended to provide documentation for developers/contributors on the Renovate project. For user-facing documentation - e.g. for how to configure Renovate as a user - please see https://docs.renovatebot.com
If you would like to contribute to Renovate or get it running locally for some others reason, please check out [contributing.md](../.github/contributing.md) for steps on how to set up the project locally.
diff --git a/docs/self-hosting.md b/docs/self-hosting.md
index 1e0f817cdb..ff24381a83 100644
--- a/docs/self-hosting.md
+++ b/docs/self-hosting.md
@@ -2,10 +2,7 @@
## Open Source vs Commercial versions
-Although Renovate is now best known as a "service" via the GitHub App, that service is actually running this same open source project, so you can get the same functionality if running it yourself. The version you see here in this repository can be cloned or `npm` installed in seconds and give you the same core functionality as in the app.
-
-There is also a commercially-licensed "Professional Edition" of Renovate available for GitHub Enterprise, that includes a stateful priority job queue, background scheduler and webhook listener.
-For details and documentation on Renovate Pro, please visit [renovatebot.com/pro](https://renovatebot.com/pro).
+Although Renovate is now best known as a "service" via the GitHub App, that service is actually running this same open source project, so you can get the same functionality if running it yourself. The version you see here in this repository can be cloned or `npm` installed in seconds and give you the same core functionality as in the app. The main feature that's missing is the responsiveness that comes from the app's use of a webhook listener (something not possible in a CLI tool).
## Installing Renovate OSS
diff --git a/lib/config/app-strings.ts b/lib/config/app-strings.ts
index 48f45622bf..be445b4bca 100644
--- a/lib/config/app-strings.ts
+++ b/lib/config/app-strings.ts
@@ -16,7 +16,7 @@ export const onboardingBranch = 'renovate/configure';
export const onboardingPrTitle = 'Configure Renovate';
export const urls = {
- documentation: 'https://renovatebot.com/docs/',
+ documentation: 'https://docs.renovatebot.com/',
help: 'https://github.com/renovatebot/config-help/issues',
homepage: 'https://renovatebot.com',
};
diff --git a/lib/manager/buildkite/readme.md b/lib/manager/buildkite/readme.md
index 7ef74a953e..7103cf41e9 100644
--- a/lib/manager/buildkite/readme.md
+++ b/lib/manager/buildkite/readme.md
@@ -37,7 +37,7 @@ N/A
---
-#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used?
+#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used?
`['buildkite\\.ya?ml', '\\.buildkite/.+\\.ya?ml$']`
diff --git a/lib/manager/bundler/readme.md b/lib/manager/bundler/readme.md
index 465750416b..8b945b10af 100644
--- a/lib/manager/bundler/readme.md
+++ b/lib/manager/bundler/readme.md
@@ -30,7 +30,7 @@ Gemfile or gemspec
---
-#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used?
+#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used?
['(^|/)(Gemfile|.gemspec)$']
diff --git a/lib/manager/cargo/readme.md b/lib/manager/cargo/readme.md
index 5775acb89c..b5666e0cfe 100644
--- a/lib/manager/cargo/readme.md
+++ b/lib/manager/cargo/readme.md
@@ -30,7 +30,7 @@ It uses exclusively `Cargo.toml` files.
---
-#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used?
+#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used?
Cargo.toml
diff --git a/lib/manager/cocoapods/readme.md b/lib/manager/cocoapods/readme.md
index 3bbcf44566..60fd16b958 100644
--- a/lib/manager/cocoapods/readme.md
+++ b/lib/manager/cocoapods/readme.md
@@ -30,7 +30,7 @@ Podfile
---
-#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used?
+#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used?
`['(^|/)Podfile$']`
diff --git a/lib/manager/composer/readme.md b/lib/manager/composer/readme.md
index cd926a69db..14a82a24c0 100644
--- a/lib/manager/composer/readme.md
+++ b/lib/manager/composer/readme.md
@@ -30,7 +30,7 @@ No, everyone uses Composer
---
-#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used?
+#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used?
`['(^|/)([\\w-]*)composer.json$']`
diff --git a/lib/manager/maven/readme.md b/lib/manager/maven/readme.md
index d668550db9..adaeee5421 100644
--- a/lib/manager/maven/readme.md
+++ b/lib/manager/maven/readme.md
@@ -32,7 +32,7 @@ Gradle
---
-#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used?
+#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used?
`['(^|/)([\\w-]*)pom.xml$']`
diff --git a/lib/manager/poetry/readme.md b/lib/manager/poetry/readme.md
index 310b414501..22048a3ec2 100644
--- a/lib/manager/poetry/readme.md
+++ b/lib/manager/poetry/readme.md
@@ -30,7 +30,7 @@ _pyproject.toml_
---
-#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used?
+#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used?
`(^|/)pyproject\\.toml$`
diff --git a/lib/manager/pub/readme.md b/lib/manager/pub/readme.md
index 0a71fccb35..93ad012231 100644
--- a/lib/manager/pub/readme.md
+++ b/lib/manager/pub/readme.md
@@ -30,7 +30,7 @@ _pubspec.yaml_
---
-#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used?
+#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used?
`(^|\/)pubspec\.yaml$`
diff --git a/lib/manager/sbt/readme.md b/lib/manager/sbt/readme.md
index 32162cc023..8deada36b5 100644
--- a/lib/manager/sbt/readme.md
+++ b/lib/manager/sbt/readme.md
@@ -31,7 +31,7 @@ As far as I know, there is 2 package files:
---
-#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used?
+#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used?
`['build\\.sbt', 'plugins\\.sbt']`
diff --git a/lib/workers/global/index.js b/lib/workers/global/index.js
index 2e3ec31f05..281e0e94e7 100644
--- a/lib/workers/global/index.js
+++ b/lib/workers/global/index.js
@@ -28,23 +28,6 @@ async function start() {
'No repositories found - did you want to run with flag --autodiscover?'
);
}
- if (
- config.platform === 'github' &&
- config.endpoint &&
- !config.customPrFooter
- ) {
- config.prFooter =
- 'Available now for Enterprise: [Renovate Pro](https://renovatebot.com/pro) with real-time webhook handling and priority job queue.';
- }
- if (
- config.platform === 'gitlab' &&
- config.endpoint &&
- !config.endpoint.startsWith('https://gitlab.com/') &&
- !config.customPrFooter
- ) {
- config.prFooter =
- 'Available now for GitLab: [Renovate Pro](https://renovatebot.com/pro) with real-time webhook handling and priority job queue.';
- }
// Move global variables that we need to use later
const importGlobals = ['prBanner', 'prFooter'];
config.global = {};
diff --git a/readme.md b/readme.md
index 02303eb592..7f00c39041 100644
--- a/readme.md
+++ b/readme.md
@@ -38,13 +38,13 @@ Renovate was released in 2017 and already is widely used in the developer commun
The easiest way to use Renovate if you are hosted on GitHub.com or GitLab.com is to install the hosted Renovate app.
For GitHub, go to [https://github.com/apps/renovate](https://github.com/apps/renovate) to install
-it now. A GitHub Marketplace plan is required only for private repositories. [More details on the GitHub App installation](https://renovatebot.com/docs/install-github-app/).
+it now. A GitHub Marketplace plan is required only for private repositories. [More details on the GitHub App installation](https://docs.renovatebot.com/install-github-app/).
-For GitLab, log into [renovatebot.com/dashboard](https://renovatebot.com/dashboard) for a convenient way to add Renovate Bot to your project. Currently the GitLab app is free for both public and private repositories. [More details on the GitLab App installation](https://renovatebot.com/docs/install-gitlab-app/).
+For GitLab, log into [app.renovatebot.com/dashboard](https://app.renovatebot.com/dashboard) for a convenient way to add Renovate Bot to your project. Currently the GitLab app is free for both public and private repositories. [More details on the GitLab App installation](https://docs.renovatebot.com/install-gitlab-app/).
## Configuration
-Visit https://renovatebot.com/docs/ for documentation, and in particular https://renovatebot.com/docs/configuration-options/ for a list of configuration options.
+Visit https://docs.renovatebot.com/ for documentation, and in particular https://docs.renovatebot.com/configuration-options/ for a list of configuration options.
You can also raise an issue in https://github.com/renovatebot/config-help if you'd like to get your config reviewed or ask any questions.
@@ -54,11 +54,11 @@ If you are not on github.com or gitlab.com, or you prefer to run your own instan
- Install the `renovate` CLI tool from npmjs, run it on a schedule (e.g. using cron)
- Run the `renovate/renovate` Docker Hub image (same content/versions as the CLI tool), run it on a schedule
-- Use [Renovate Pro Edition](https://renovatebot.com/pro) available for GitHub Enterprise and GitLab, includes native scheduler
+- Run the `renovate/renovate:slim` Docker Hub image if you only use package managers that don't need third party binaries (e.g. JS, Docker, Nuget, pip)
## Contributing
-If you would like to contribute to Renovate or get a local copy running for some other reason, please see the instructions in [contributing.md](.github/contributing.md).
+If you would like to contribute to Renovate or get a local copy running for some other reason, please see the instructions in [.github/contributing.md](.github/contributing.md).
## Security / Disclosure
diff --git a/website/docs/config-presets.md b/website/docs/config-presets.md
index dc6334b992..6d44b3ae2f 100644
--- a/website/docs/config-presets.md
+++ b/website/docs/config-presets.md
@@ -9,7 +9,7 @@ Renovate's "config presets" are a convenient way to distribute config that is re
In short:
-- Browse [Renovate's default presets](https://renovatebot.com/docs/presets-default/) to find any that are useful to you
+- Browse [Renovate's default presets](https://docs.renovatebot.com/presets-default/) to find any that are useful to you
- Publish your own if you wish to reuse them across repositories
## Goals of Preset Configs
diff --git a/website/docs/configuration-options.md b/website/docs/configuration-options.md
index 3a92b021a3..85d8a17dbc 100644
--- a/website/docs/configuration-options.md
+++ b/website/docs/configuration-options.md
@@ -263,7 +263,7 @@ Example:
## encrypted
-See https://renovatebot.com/docs/private-modules for details on how this is used to encrypt npm tokens.
+See https://docs.renovatebot.com/private-modules for details on how this is used to encrypt npm tokens.
## engines
@@ -281,7 +281,7 @@ Be careful you know what you're doing with this option. The initial intended use
## extends
-See https://renovatebot.com/docs/config-presets for details.
+See https://docs.renovatebot.com/config-presets for details.
## fileMatch
@@ -552,17 +552,17 @@ Add to this object if you wish to define rules that apply only to minor updates.
Using this configuration option allows you to apply common configuration and policies across all Node.js version updates even if managed by different package managers (`npm`, `yarn`, etc.).
-Check out our [Node.js documentation](https://renovatebot.com/docs/node) for a comprehensive explanation of how the `node` option can be used.
+Check out our [Node.js documentation](https://docs.renovatebot.com/node) for a comprehensive explanation of how the `node` option can be used.
## npm
## npmToken
-See https://renovatebot.com/docs/private-modules for details on how this is used. Typically you would encrypt it and put it inside the `encrypted` object.
+See https://docs.renovatebot.com/private-modules for details on how this is used. Typically you would encrypt it and put it inside the `encrypted` object.
## npmrc
-See https://renovatebot.com/docs/private-modules for details on how this is used.
+See https://docs.renovatebot.com/private-modules for details on how this is used.
## nuget
@@ -1022,7 +1022,7 @@ The `schedule` option allows you to define times of week or month for Renovate u
The default value for `schedule` is "at any time", which is functionally the same as declaring a `null` schedule. 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://renovatebot.com/docs/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.
+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.
Otherwise, here are some text schedules that are known to work:
@@ -1107,7 +1107,7 @@ This feature is added for people migrating from alternative services who are use
Language support is limited to those listed below:
-- **Node.js** - [Read our Node.js documentation](https://renovatebot.com/docs/node#configuring-support-policy)
+- **Node.js** - [Read our Node.js documentation](https://docs.renovatebot.com/node#configuring-support-policy)
## suppressNotifications
diff --git a/website/docs/docker.md b/website/docs/docker.md
index 0572bd6d36..201edddbeb 100644
--- a/website/docs/docker.md
+++ b/website/docs/docker.md
@@ -109,7 +109,7 @@ module.exports = {
Alternatively, configure `DOCKER_USERNAME` and `DOCKER_PASSWORD` in env to achieve the same.
-The above two approaches create an identical host rule in renovatebot. It is possible to add additional host rules following the [documentation](https://renovatebot.com/docs/configuration-options/#hostrules)
+The above two approaches create an identical host rule in renovatebot. It is possible to add additional host rules following the [documentation](https://docs.renovatebot.com/configuration-options/#hostrules)
For example if you have some images you host yourself and some images you pull from docker hub without logging in you can configure that like this:
diff --git a/website/docs/golang.md b/website/docs/golang.md
index a621b33a3a..cb5797473f 100644
--- a/website/docs/golang.md
+++ b/website/docs/golang.md
@@ -14,20 +14,20 @@ Renovate supports upgrading dependencies in `go.mod` files and their accompanyin
3. Renovate will resolve the dependency's source repository and check for semver tags if found. Otherwise commits and `v0.0.0-....` syntax will be used.
4. If an update was found, Renovate will update `go.mod` to the new value
5. Renovate will run `go get` to update the `go.sum` files.
-6. If the user has enabled the option `gomodTidy` in the [`postUpdateOptions`](https://renovatebot.com/docs/configuration-options/#postupdateoptions) array, then Renovate will run `go mod tidy`, which itself can update `go.mod` and `go.sum`.
+6. If the user has enabled the option `gomodTidy` in the [`postUpdateOptions`](https://docs.renovatebot.com/configuration-options/#postupdateoptions) array, then Renovate will run `go mod tidy`, which itself can update `go.mod` and `go.sum`.
7. `go mod vendor` will be run if vendored modules have been detected.
8. A PR will be created with `go.mod`,`go.sum`, and any updated vendored files updated in the one commit
9. If the source repository has either a "changelog" file or uses GitHub releases, then Release Notes for each version will be embedded in the generated PR.
## Enabling Go Modules Updating
-Go Modules updating is on by default in Renovate Bot. To install Renovate Bot itself, either enable the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) or [Renovate Pro](https://renovatebot.com/pro) for self-hosted options.
+Go Modules updating is on by default in Renovate Bot. To install Renovate Bot itself, either enable the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) for self-hosted.
## Technical Details
#### Module Tidying
-Go Modules tidying is not enabled by default, and so is opt-in via the [`postUpdateOptions`](https://renovatebot.com/docs/configuration-options/#postupdateoptions) config option. The reason for this is that a `go mod tidy` command may make changes to `go.mod` and `go.sum` that are completely unrelated to the updated module(s) in the PR, and so may be confusing to some users.
+Go Modules tidying is not enabled by default, and so is opt-in via the [`postUpdateOptions`](https://docs.renovatebot.com/configuration-options/#postupdateoptions) config option. The reason for this is that a `go mod tidy` command may make changes to `go.mod` and `go.sum` that are completely unrelated to the updated module(s) in the PR, and so may be confusing to some users.
#### Module Vendoring
diff --git a/website/docs/install-gitlab-app.md b/website/docs/install-gitlab-app.md
index a5a6f971ff..8c3558ab30 100644
--- a/website/docs/install-gitlab-app.md
+++ b/website/docs/install-gitlab-app.md
@@ -15,7 +15,7 @@ Renovate runs as the user [@renovate-bot](https://gitlab.com/renovate-bot) on [g
### Dashboard
-First, sign into the [Dashboard](https://renovatebot.com/dashboard) using GitLab OAuth.
+First, sign into the [Dashboard](https://app.renovatebot.com/dashboard) using GitLab OAuth.
diff --git a/website/docs/php.md b/website/docs/php.md
index b0e38031eb..2946dee24f 100644
--- a/website/docs/php.md
+++ b/website/docs/php.md
@@ -17,4 +17,4 @@ Renovate supports upgrading dependencies in PHP's `composer.json` files and thei
## Enabling
-Either install the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) or [Renovate Pro](https://renovatebot.com/pro) for self-hosted options.
+Either install the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) for self-hosted.
diff --git a/website/docs/ruby.md b/website/docs/ruby.md
index 96dadfa2b3..2d8e6dbae6 100644
--- a/website/docs/ruby.md
+++ b/website/docs/ruby.md
@@ -17,7 +17,7 @@ Renovate supports upgrading dependencies in Bundler's `Gemfile`s and their accom
## Enabling
-Either install the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) or [Renovate Pro](https://renovatebot.com/pro) for self-hosted options.
+Either install the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) for self-hosted.
Because Bundler is considered to be in alpha stage, it is not enabled by default. To opt-in to using it, `bundler.enabled` must be set to `true` in your config. If you are using the hosted Renovate App, then either:
--
GitLab