docs: move manager docs out of config options (#5410)

lib/config/definitions.ts

@@ -24,6 +24,8 @@ export interface RenovateOptionBase {
   freeChoice?: boolean;
   mergeable?: boolean;
 
+  autogenerated?: boolean;
+
   name: string;
 
   parent?: 'hostRules' | 'packageRules' | 'postUpgradeTasks';
@@ -1690,6 +1692,7 @@ function loadManagerOptions(): void {
         default: config.defaultConfig,
         mergeable: true,
         cli: false,
+        autogenerated: true,
       };
       options.push(managerConfig);
     }

lib/manager/ansible/readme.md

@@ -0,0 +1 @@
+Add configuration here if you want to enable or disable something in particular for Ansible files and override the default Docker settings.

lib/manager/bazel/readme.md

@@ -0,0 +1 @@
+Bazel is quite unlike most other "package managers" that Renovate supports, which usually focus on a particular ecosystem like JavaScript, Ruby or Docker. Instead, Bazel is a build tool so supports a multitude of languages/datasources. Renovate does not support all possible Bazel references, although would like to, and feature requests are welcome.

lib/manager/cdnurl/readme.md

@@ -0,0 +1,11 @@
+**Important**: This manager isn't aware of subresource integrity (SRI) hashes. It will search/replace any matching url it finds, without consideration for things such as script integrity hashes.
+
+To enable this manager, add the matching files to `cdnurl.fileMatch`. For example:
+
+```json
+{
+  "cdnurl": {
+    "fileMatch": ["\\.html?$"]
+  }
+}
+```

lib/manager/github-actions/readme.md

@@ -0,0 +1,3 @@
+**Important note**: For security reasons, GitHub has blocked integrations/apps from editing GitHub Actions workflow files in _any_ branch, so this only works on GitHub if using a Personal Access Token instead of using the WhiteSource Renovate app.
+
+Add to this configuration setting if you need to override any of the GitHub Actions default settings.

lib/manager/gomod/readme.md

@@ -0,0 +1 @@
+You might be interested to add `"postUpdateOptions": ["gomodTidy"]` to your config if you'd like Renovate to run `go mod tidy` after every update before raising the PR.

lib/manager/gradle-wrapper/readme.md

@@ -0,0 +1 @@
+Configuration for Gradle Wrapper updates. Changes here affect how Renovate updates the version of gradle in the wrapper, not how it uses the wrapper.

lib/manager/helm-requirements/readme.md

@@ -0,0 +1 @@
+Renovate supports updating Helm Chart references within `requirements.yaml` files. If your Helm charts make use of Aliases then you will need to configure an `aliases` object in your config to tell Renovate where to look for them.

lib/manager/helm-values/readme.md

@@ -0,0 +1,10 @@
+Renovate supports updating of Docker dependencies within Helm Chart `values.yaml` files or other YAML
+files that use the same format (via `fileMatch` configuration). Updates are performed if the files
+follow the conventional format used in most of the `stable` Helm charts:
+
+```yaml
+image:
+  repository: 'some-docker/dependency'
+  tag: v1.0.0
+  registry: registry.example.com # optional key, will default to "docker.io"
+```

lib/manager/kubernetes/readme.md

@@ -0,0 +1,33 @@
+Add to this configuration object if you need to override any of the Kubernetes manager default settings. Use the `docker` config object instead if you wish for configuration to apply across all Docker-related package managers.
+
+It's important to note that the `kubernetes` manager by default has no `fileMatch` defined - i.e. so it will never match any files unless you configure it. This is because there is no commonly accepted file/directory naming convention for Kubernetes YAML files and we don't want to download every single `*.yaml` file in repositories just in case any of them contain Kubernetes definitions.
+
+If most `.yaml` files in your repository are Kubnernetes ones, then you could add this to your config:
+
+```json
+{
+  "kubernetes": {
+    "fileMatch": ["\\.yaml$"]
+  }
+}
+```
+
+If instead you have them all inside a `k8s/` directory, you would add this:
+
+```json
+{
+  "kubernetes": {
+    "fileMatch": ["k8s/.+\\.yaml$"]
+  }
+}
+```
+
+Or if it's just a single file then something like this:
+
+```json
+{
+  "kubernetes": {
+    "fileMatch": ["^config/k8s\\.yaml$"]
+  }
+}
+```

lib/manager/npm/readme.md

@@ -0,0 +1,8 @@
+The following `depTypes` are currently supported by the npm manager :
+
+- `dependencies`
+- `devDependencies`
+- `optionalDependencies`
+- `peerDependencies`
+- `engines` : Renovate will update any `node`, `npm` and `yarn` version specified under `engines`.
+- `volta` : Renovate will update any `node` and `yarn` version specified under `volta`.

lib/manager/nuget/readme.md

@@ -0,0 +1 @@
+The `nuget` configuration object is used to control settings for the NuGet package manager. The NuGet package manager supports SDK-style `.csproj`/`.fsproj`/`.vbproj` format, as described [here](https://natemcmaster.com/blog/2017/03/09/vs2015-to-vs2017-upgrade/). This means that .NET Core projects are all supported but any .NET Framework projects need to be updated to the new `.csproj`/`.fsproj`/`.vbproj` format in order to be detected and supported by Renovate.

lib/manager/pip_requirements/readme.md

@@ -0,0 +1 @@
+Add configuration here to specifically override settings for `pip` requirements files. Supports `requirements.txt` and `requirements.pip` files. The default file pattern is fairly flexible in an attempt to catch similarly named ones too but may be extended/changed.

lib/manager/sbt/readme.md

@@ -0,0 +1,2 @@
+It isn't supporting Scala version inference well (`%%` operator), just searching for package like `<artifactId>_<scalaVersion>` without any additional resolving.
+In case of problems, please use explicit versions with `%` operator.

lib/manager/swift/readme.md

@@ -0,0 +1,13 @@
+Anything other than `.exact(<...>)` will be treated as range with respect to Swift specific.
+Because of this, some PR descriptions will look like `from: <...> => <...>`.
+
+Examples:
+
+```swift
+package(name: "<...>", from: "1.2.3")     // => from: "2.0.0"
+package(name: "<...>", "1.2.3"...)        // => "2.0.0"...
+package(name: "<...>", "1.2.3"..."1.3.0") // => "1.2.3"..."2.0.0"
+package(name: "<...>", "1.2.3"..<"1.3.0") // => "1.2.3"..<"2.0.0"
+package(name: "<...>", ..."1.2.3")        // => ..."2.0.0"
+package(name: "<...>", ..<"1.2.3")        // => ..<"2.0.0"
+```

lib/manager/terraform/readme.md

@@ -0,0 +1,19 @@
+Currently Terraform support is limited to Terraform registry sources and github sources that include semver refs, e.g. like `github.com/hashicorp/example?ref=v1.0.0`.
+
+Fixed versions like the following will receive a PR whenever there is a newer version available:
+
+```
+module "consul" {
+  source  = "hashicorp/consul/aws"
+  version = "0.0.5"
+  servers = 3
+}
+```
+
+The following _range_ constraints are also supported:
+
+- `>= 1.2.0`: version 1.2.0 or newer
+- `<= 1.2.0`: version 1.2.0 or older
+- `~> 1.2.0`: any non-beta version >= 1.2.0 and < 1.3.0, e.g. 1.2.X
+- `~> 1.2`: any non-beta version >= 1.2.0 and < 2.0.0, e.g. 1.X.Y
+- `>= 1.0.0`, <= 2.0.0`: any version between 1.0.0 and 2.0.0 inclusive

test/website-docs.spec.ts

@@ -20,6 +20,7 @@ describe('docs', () => {
     .filter(option => option.releaseStatus !== 'unpublished')
     .filter(option => !option.admin)
     .filter(option => !option.parent)
+    .filter(option => !option.autogenerated)
     .map(option => option.name)
     .sort();