Commit Graph

45 Commits

Author SHA1 Message Date
Jamie Tanna b62fe59594 fix: remove references to "bot" (#39305)
We dropped the "bot" from our terminology long ago, but it looks like
we've got some outdated docs + code that reference it.

We should remove this to keep things consistent.

A `fix`, as we're changing the commit author's name, and log lines.

Co-authored-by: Claude Sonnet 5 <jamie.tanna+claude-code@mend.io>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
2026-09-02 08:56:20 +00:00
Jamie Tanna 128f446e08 docs: ensure that config in documentation is error and warning free (#43727)
* docs: skip validation on JSON files that aren't Renovate config

As part of future changes, we'll enable validation on all JSON code
snippets to run Config Validation.

Before we do that, we should opt-out JSON snippets that aren't anything
related to Renovate config.

* docs: don't validate invalid Renovate config

As it's intentionally referencing a manager that doesn't exist.

* docs: don't validate partial Renovate config

As part of future changes, we'll enable validation on all JSON code
snippets to run Config Validation.

There are several code snippets we have that are part of a Renovate JSON,
but it doesn't make sense to convert these to a fully passing config, as
it'd reduce clarity on what we're trying to explain.

* docs: convert `baseBranchPatterns` snippets to code blocks

So we can validate them.

* docs: make sure that `datasourceTemplate` is set

So this passes validation.

* docs: clarify that `force` is global config

As it may not be clear, so we can make it extra clear with a `.js` file,
and note that it's global self-hosted config.

* docs: make sure `packageRules` is an array

* docs: `matchBaseBranches` needs `baseBranchPatterns` to be set

* docs: correct typo for `prBodyColumns`

* docs: mark global config snippets as such

As part of future changes, we'll use this to detect whether it's global
self-hosted configuration.

* docs: make sure `packageRules` wraps its children

* docs: add `allowedHeaders`

* docs: ignore deprecation warnings

As part of future changes, we'll use this to note that we don't care
about the validation warnings.

* docs: make sure `customManagers` wraps its children

* docs: make sure `fleet` wraps its children

* docs: validate JSON snippets are valid Renovate config

To make sure that we're always presenting valid JSON configuration to
our users, we can validate them as part of `check-fenced-code`.

As well as configuration errors we can warn for warnings, but allow code
blocks to opt-out, for instance when there's a known deprecation
affecting the code block.

We need to make sure to set `allowedEnv` for various code snippets that
reference environment variables.

* docs(development): document fenced code block checks

* docs: wrap `configType` and `ignoreConfigWarnings` in `{ ... }`

As otherwise we see build failures i.e.

    WARNING -  Doc file 'modules/platform/gitlab/index.md' contains a link
       '../../../self-hosted-configuration.md#autodiscoverrepoorder', but the doc
       'self-hosted-configuration.md' does not contain an anchor '#autodiscoverrepoorder'.

This needs to be wrapped alongside all other options like `title`.

* fixup! docs: wrap `configType` and `ignoreConfigWarnings` in `{ ... }`
2026-06-02 13:29:48 +00:00
Jamie Tanna a462e4ec3b refactor(docs): don't use an end for autogenerated docs (#43242)
* refactor(docs): don't use an `end` for autogenerated docs

As part of #42910, we wanted to avoid needing a "begin" and "end" to
each of our autogenerated docs replacements.

While looking into it, we're not actually using the "end" for anything,
so we can instead refactor this to be a single-line replacement.

To simplify the code and docs, we can remove this. At the point we need
this again, we can re-add the functionality.

Co-authored-by: Claude Sonnet 4.6 <jamie.tanna+claude-code@mend.io>

* fixup! Merge remote-tracking branch 'origin/HEAD' into chore/no-replaceStop

---------

Co-authored-by: Claude Sonnet 4.6 <jamie.tanna+claude-code@mend.io>
2026-05-13 15:49:00 +00:00
RahulGautamSingh ff27ebee2b docs: use unicode arrow (→) instead of ASCII (->) (#42896)
* chore(docs): use unicode arrow (→) instead of ASCII (->)

* more changes
2026-04-27 07:11:16 +00:00
Jamie Tanna fb418d6ec8 docs: show all Managers in sidebar (#42155)
As we do with the other modules, we should include Managers too.

Although there are many, it can be a little jarring not seeing the list
of Managers when viewing a specific one.

This requires we also show the "display name" (`Ansible`) in the
sidebar, and then use the more verbose `Automated Dependency Updates for
Ansible` as the header.

To do this, we can utilise the `sidebar_label` (which was previously
used in Docusarus, but unused by Material for MkDocs) via a custom hook
to inject the label for the sidebar.

Unfortunately this requires a custom hook, which will make moving away
from Material for MkDocs (to Zensical) a little less straightforward.

Co-authored-by: Claude Sonnet 4.6 <jamie.tanna+claude-code@mend.io>
2026-04-23 12:21:02 +00:00
Rhys Arkins 67935500d7 feat(versioning): isBreaking (#31859)
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
2025-05-09 08:17:14 +00:00
RahulGautamSingh 1ea20d5285 fix(docs): correct typo in internal links (#35710) 2025-05-04 15:43:55 +00:00
RahulGautamSingh bc7d0595d0 feat(config): managerFilePatterns (#34615)
Co-authored-by: Sebastian Poxhofer <secustor@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2025-05-04 08:30:24 +00:00
Rhys Arkins 879f7cc212 feat(packageRules): migrate matchers and excludes (#28602)
Co-authored-by: Sebastian Poxhofer <secustor@users.noreply.github.com>
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
2024-07-25 15:28:16 +02:00
Michael Kriese 23421c572c docs: add modules introduction (#29038)
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2024-05-14 07:43:26 +00:00
Michael Kriese f7ca230b79 docs(versioning): split to seperate pages and add open issues (#28314) 2024-04-11 11:00:47 +00:00
HonkingGoose 71d59355b9 docs(versioning): small style fixes (#26352) 2023-12-18 15:22:41 +00:00
Michael Kriese 3023d4700b docs: more link fixes (#25687) 2023-11-10 11:00:35 +00:00
Michael Kriese f5cb2c4d5e docs: fix more links (#25686) 2023-11-10 10:01:46 +00:00
HonkingGoose b58322920c docs: use titles for more code blocks (#25526) 2023-11-02 16:04:33 +00:00
Sebastian Poxhofer 69652bb572 docs(managers): remove reference to removed languages (#23177) 2023-07-05 14:23:56 +00:00
Michael Kriese f9e3e80e0c feat(presets)!: rename config:base to config:recommended (#21136)
Closes #12024

Co-authored-by: Rhys Arkins <rhys@arkins.net>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: Bastian Gutschke <bastian.gutschke@gmx.de>

BREAKING CHANGE: Preset config:base is now called config:recommended
2023-07-04 19:21:52 +02:00
Matthias Schoettle 3e325e900f docs: improve documentation around fileMatch being additive (#20084)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2023-01-30 07:15:53 +01:00
Michael Kriese f2a8699277 docs: separate pages for datasources (#19611) 2022-12-30 18:20:41 +01:00
Michael Kriese 4809dbdc23 docs: new nav (#19188) 2022-12-05 12:57:57 +01:00
Colin O'Dell 275ef417d8 docs: versioning should not be combined with matchUpdateTypes (#17220)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2022-08-17 11:07:39 +02:00
HonkingGoose 805988ecc3 docs(datasources): rewrite intro (#15725) 2022-05-26 08:02:34 +02:00
August Feng 53667eac46 docs: fix typo (#14874) 2022-03-31 02:34:17 +00:00
HonkingGoose 5a52b04c96 docs: replace contain(s) with has or have (#14692) 2022-03-16 14:50:20 +01:00
HonkingGoose 7d2aa43457 docs: remove obsolete text (#13515) 2022-01-12 12:17:56 +01:00
HonkingGoose 01689f90dc docs: update autogenerate comment (#13488) 2022-01-11 15:25:14 +00:00
Michael Kriese e4c938b7a5 docs: release as asset (#11429)
* docs: prepare release as asset

* chore: cleanup

* fix: wrong extension

* fix: wrong logger

* fix: wrong path

* chore: clean and create tmp

* chore: fix types

* fix: update generation

* Update .github/workflows/build.yml

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update lib/datasource/types.ts

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2021-12-09 21:12:49 +01:00
HonkingGoose 341acf2724 docs: hyphenate word third-party (#12967) 2021-12-06 11:54:43 +00:00
Michael Kriese f871090a3b docs: prepare for platform details (#11423)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2021-08-25 11:12:36 +00:00
Ville Skyttä aa2607cf2c docs(versioning): remove versionScheme references (#11397)
Co-authored-by: Jamie Magee <jamie.magee@gmail.com>
2021-08-23 21:11:39 +00:00
HonkingGoose aacfe0b1ff docs: sort platforms alphabetically (#9878) 2021-05-05 20:36:36 +02:00
HonkingGoose 06e73fb22c docs: improve Platform support docs (#9867) 2021-05-05 09:23:32 +00:00
HonkingGoose 20752c8118 docs: improve versioning documentation (#9017) 2021-03-27 06:50:57 +01:00
HonkingGoose aa9b346934 docs: improve manager docs (#8869) 2021-02-26 07:47:15 +01:00
Rhys Arkins 2d3b44401c docs: clarify experimental manager example 2021-02-15 09:11:55 +01:00
Sergei Zharinov 72b0b85640 feat(config): Rename packageRules selectors (#6939) 2021-01-29 11:43:42 +01:00
HonkingGoose 104c3fa1ca docs: improve manager documentation (#7738)
Co-authored-by: Jamie Magee <JamieMagee@users.noreply.github.com>
2020-11-23 15:54:35 +01:00
HonkingGoose 2eb9604b57 docs: improve versioning documentation (#7753) 2020-11-18 13:53:44 +01:00
HonkingGoose bc3fd867ff docs: improve platform documentation (#7739)
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
2020-11-17 15:05:11 +01:00
HonkingGoose b6cdb157bc docs: improve datasource (#7734)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2020-11-16 13:29:11 +01:00
HonkingGoose 32dd490672 docs: use one sentence per line (#7625) 2020-11-02 09:52:37 +01:00
HonkingGoose 89346338cb docs: fix capitalization/style errors (#7532)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2020-10-23 17:42:57 +02:00
Pascal Mathis c9357cc340 feat: add support for gitea platform (#5509) 2020-02-19 11:19:25 +01:00
Rhys Arkins 14be7f39f8 chore: simpler autogenerate replace 2020-02-18 14:30:04 +01:00
Rhys Arkins 2d86782e23 docs: add initial modules docs 2020-02-18 09:48:23 +01:00