docs: generate pure markdown documentation (#251)

Switch to building documentation in markdown, avoiding the markdown+html hybrid we have. Closes #250 Signed-off-by: Francesco Canovai <francesco.canovai@enterprisedb.com>
2026-01-11 13:23:09 +01:00 · 2025-04-17 13:19:35 +01:00 · 2025-04-17 13:19:35 +01:00 · c37047029d
commit c37047029d
parent 898b5695f2
11 changed files with 195 additions and 277 deletions
--- a/Taskfile.yml
+++ b/Taskfile.yml
@ -58,6 +58,7 @@ tasks:
    desc: Check for uncommitted changes
    deps:
      - manifest-main
+      - apidoc
    env:
      # renovate: datasource=git-refs depName=uncommitted lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main
      DAGGER_UNCOMMITTED_SHA: db65290569cb7723a32e72fcfb134668e7b998c8
@ -68,17 +69,26 @@ tasks:

  apidoc:
    desc: Update the API Reference section of the documentation
+    deps:
+      - controller-gen
    env:
-      # renovate: datasource=git-refs depName=genref lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main
-      DAGGER_APIDOC_SHA: db65290569cb7723a32e72fcfb134668e7b998c8
+      # renovate: datasource=git-refs depName=crd-gen-refs lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main
+      DAGGER_CRDGENREF_SHA: ba865842d907910c469d016c3ecfa009e4c66915
    cmds:
-      - GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/genref@${DAGGER_APIDOC_SHA} genref --source .
-        --args "-c=config.yaml" --args "-o=src" --args "-include=plugin-barman-cloud"
-        file --path src/plugin-barman-cloud.v1.md
+      - >
+        GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/crd-ref-docs@${DAGGER_CRDGENREF_SHA} generate
+        --src .
+        --source-path api/v1
+        --config-file docs/config.yaml
+        --renderer markdown
+        --templates-dir docs/markdown
+        file --path out.md
        export --path docs/src/plugin-barman-cloud.v1.md
    sources:
      - ./api/**/*.go
      - ./docs/config.yaml
+      - ./docs/markdown/**/*.tpl
+      - ./Taskfile.yml
    generates:
      - ./docs/src/plugin-barman-cloud.v1.md

@ -338,6 +348,7 @@ tasks:

  controller-gen:
    desc: Run controller-gen
+    run: once
    env:
      # renovate: datasource=git-refs depName=controller-gen lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main
      DAGGER_CONTROLLER_GEN_SHA: db65290569cb7723a32e72fcfb134668e7b998c8
--- a/api/v1/groupversion_info.go
+++ b/api/v1/groupversion_info.go
@ -14,9 +14,6 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */

-// Package v1 contains API Schema definitions for the barmancloud v1 API group
-// +kubebuilder:object:generate=true
-// +groupName=barmancloud.cnpg.io
 package v1

 import (
--- a/docs/config.yaml
+++ b/docs/config.yaml
@ -1,24 +1,20 @@
-hiddenMemberFields:
-  - "TypeMeta"
+processor:
+  ignoreGroupVersions:
+    - "GVK"
+  customMarkers:
+    - name: "optional"
+      target: field
+  ignoreFields:
+#    - "status$"
+    - "TypeMeta$"
+  ignoreTypes:
+    - "ObjectStoreList$"

-externalPackages:
-  - match: ^k8s\.io/(api|apimachinery/pkg/apis)/
-    target: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#{{- lower .TypeIdentifier -}}-{{- arrIndex .PackageSegments -1 -}}-{{- arrIndex .PackageSegments -2 -}}
-  - match: ^github\.com/cloudnative-pg/barman-cloud
-    target: https://pkg.go.dev/github.com/cloudnative-pg/barman-cloud/pkg/api/#{{- .TypeIdentifier }}
-
-hideTypePatterns:
-  - "ParseError$"
-  - "\\.ObjectStoreList$"
-
-markdownDisabled: false
-
-stripPrefix:
-  - k8s.io/api/
-  - k8s.io/apimachinery/pkg/apis/
-
-apis:
-  - name: plugin-barman-cloud
-    title: API Reference
-    package: github.com/cloudnative-pg/plugin-barman-cloud
-    path: api/v1
+render:
+  # Version of Kubernetes to use when generating links to Kubernetes API documentation.
+  # renovate: datasource=git-refs depName=kubernetes/kubernetes lookupName=https://github.com/kubernetes/kubernetes
+  kubernetesVersion: 1.31
+  knownTypes:
+  - name: BarmanObjectStoreConfiguration
+    package: github.com/cloudnative-pg/barman-cloud/pkg/api
+    link: https://pkg.go.dev/github.com/cloudnative-pg/barman-cloud/pkg/api#BarmanObjectStoreConfiguration
--- a/docs/markdown/gv_details.tpl
+++ b/docs/markdown/gv_details.tpl
@ -0,0 +1,19 @@
+{{- define "gvDetails" -}}
+{{- $gv := . -}}
+
+## {{ $gv.GroupVersionString }}
+
+{{ $gv.Doc }}
+
+{{- if $gv.Kinds  }}
+### Resource Types
+{{- range $gv.SortedKinds }}
+- {{ $gv.TypeForKind . | markdownRenderTypeLink }}
+{{- end }}
+{{ end }}
+
+{{ range $gv.SortedTypes }}
+{{ template "type" . }}
+{{ end }}
+
+{{- end -}}
--- a/docs/markdown/gv_list.tpl
+++ b/docs/markdown/gv_list.tpl
@ -0,0 +1,15 @@
+{{- define "gvList" -}}
+{{- $groupVersions := . -}}
+
+# API Reference
+
+## Packages
+{{- range $groupVersions }}
+- {{ markdownRenderGVLink . }}
+{{- end }}
+
+{{ range $groupVersions }}
+{{ template "gvDetails" . }}
+{{ end }}
+
+{{- end -}}
--- a/docs/markdown/members.tpl
+++ b/docs/markdown/members.tpl
@ -1,34 +0,0 @@
-{{ define "members" }}
-  {{- /* . is a apiType */ -}}
-  {{- range .GetMembers -}}
-    {{- /* . is a apiMember */ -}}
-    {{- if not .Hidden }}
-<tr><td><code>{{ .FieldName }}</code>
-      {{- if and (not .IsOptional) (not .IsInline) }} <B>[Required]</B>{{- end -}}
-<br/>
-{{/* Link for type reference */}}
-      {{- with .GetType -}}
-        {{- if .Link -}}
-<a href="{{ .Link }}"><i>{{ .DisplayName }}</i></a>
-        {{- else -}}
-<i>{{ .DisplayName }}</i>
-        {{- end -}}
-      {{- end }}
-</td>
-<td>
-   {{- if .IsInline -}}
-(Members of <code>{{ .FieldName }}</code> are embedded into this type.)
-   {{- end }}
-   {{ if .GetComment -}}
-   {{ .GetComment }}
-   {{- else -}}
-   <span class="text-muted">No description provided.</span>
-   {{- end }}
-   {{- if and (eq (.GetType.Name.Name) "ObjectMeta") -}}
-Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field.
-   {{- end -}}
-</td>
-</tr>
-    {{- end }}
-  {{- end }}
-{{ end }}
--- a/docs/markdown/pkg.tpl
+++ b/docs/markdown/pkg.tpl
@ -1,43 +0,0 @@
-{{ define "packages" -}}
-
-# API Reference
-
-{{ $grpname := "" -}}
-{{- range $idx, $val := .packages -}}
-  {{- if and (ne .GroupName "") (eq $grpname "") -}}
-{{ .GetComment -}}
-{{- $grpname = .GroupName -}}
-  {{- end -}}
-{{- end }}
-
-## Resource Types
-
-{{ range .packages -}}
-  {{- /* if ne .GroupName "" */ -}}
-    {{- range .VisibleTypes -}}
-      {{- if .IsExported }}
- [{{ .DisplayName }}]({{ .Link }})
-      {{- end -}}
-    {{- end -}}
-  {{- /* end */ -}}
-{{- end -}}
-
-{{- range .packages -}}
-  {{- if ne .GroupName "" -}}
-
-    {{- /* For package with a group name, list all type definitions in it. */ -}}
-    {{- range .VisibleTypes -}}
-      {{- if or .Referenced .IsExported -}}
-{{ template "type" . }}
-      {{- end -}}
-    {{- end }}
-  {{- else -}}
-    {{- /* For package w/o group name, list only types referenced. */ -}}
-    {{- range .VisibleTypes -}}
-      {{- if .Referenced -}}
-{{ template "type" . }}
-      {{- end -}}
-    {{- end }}
-  {{- end }}
-{{- end }}
-{{- end }}
--- a/docs/markdown/type.tpl
+++ b/docs/markdown/type.tpl
@ -1,37 +1,49 @@
-{{ define "type" }}
+{{- define "type" -}}
+{{- $type := . -}}
+{{- if markdownShouldRenderType $type -}}

-## {{ .Name.Name }}     {#{{ .Anchor }}}
+#### {{ $type.Name }}

-{{ if eq .Kind "Alias" -}}
-(Alias of `{{ .Underlying }}`)
-{{ end }}
+{{ if $type.IsAlias }}_Underlying type:_ _{{ markdownRenderTypeLink $type.UnderlyingType  }}_{{ end }}

-{{- with .References }}
-**Appears in:**
-{{ range . }}
-{{ if or .Referenced .IsExported -}}
- [{{ .DisplayName }}]({{ .Link }})
-{{ end -}}
-{{- end -}}
+{{ $type.Doc }}
+
+{{ if $type.Validation -}}
+_Validation:_
+{{- range $type.Validation }}
+- {{ . }}
+{{- end }}
 {{- end }}

-{{ if .GetComment -}}
-{{ .GetComment }}
-{{ end }}
-{{ if .GetMembers -}}
-<table class="table">
-<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
-<tbody>
-    {{- /* . is a apiType */ -}}
-    {{- if .IsExported -}}
-{{- /* Add apiVersion and kind rows if deemed necessary */}}
-<tr><td><code>apiVersion</code> <B>[Required]</B><br/>string</td><td><code>{{- .APIGroup -}}</code></td></tr>
-<tr><td><code>kind</code> <B>[Required]</B><br/>string</td><td><code>{{- .Name.Name -}}</code></td></tr>
-    {{- end -}}
+{{ if $type.References -}}
+_Appears in:_
+{{- range $type.SortedReferences }}
+- {{ markdownRenderTypeLink . }}
+{{- end }}
+{{- end }}
+
+{{ if $type.Members -}}
+| Field | Description | Required | Default | Validation |
+| --- | --- | --- | --- | --- |
+{{ if $type.GVK -}}
+| `apiVersion` _string_ | `{{ $type.GVK.Group }}/{{ $type.GVK.Version }}` | True | | |
+| `kind` _string_ | `{{ $type.GVK.Kind }}` | True | | |
+{{ end -}}
+
+{{ range $type.Members -}}
+| `{{ .Name  }}` _{{ markdownRenderType .Type }}_ | {{ template "type_members" . }} | {{ if not .Markers.optional -}}True{{- end }} | {{ markdownRenderDefault .Default }} | {{ range .Validation -}} {{ markdownRenderFieldDoc . }} <br />{{ end }} |
+{{ end -}}
+
+{{ end -}}
+
+{{ if $type.EnumValues -}} 
+| Field | Description |
+| --- | --- |
+{{ range $type.EnumValues -}}
+| `{{ .Name }}` | {{ markdownRenderFieldDoc .Doc }} |
+{{ end -}}
+{{ end -}}
+

-{{/* The actual list of members is in the following template */}}
-{{- template "members" . -}}
-</tbody>
-</table>
 {{- end -}}
 {{- end -}}
--- a/docs/markdown/type_members.tpl
+++ b/docs/markdown/type_members.tpl
@ -0,0 +1,8 @@
+{{- define "type_members" -}}
+{{- $field := . -}}
+{{- if eq $field.Name "metadata" -}}
+Refer to Kubernetes API documentation for fields of `metadata`.
+{{- else -}}
+{{ markdownRenderFieldDoc $field.Doc }}
+{{- end -}}
+{{- end -}}
--- a/docs/src/plugin-barman-cloud.v1.md
+++ b/docs/src/plugin-barman-cloud.v1.md
@ -1,179 +1,104 @@
 # API Reference

-<p>Package v1 contains API Schema definitions for the barmancloud v1 API group</p>
+## Packages
+- [barmancloud.cnpg.io/v1](#barmancloudcnpgiov1)


-## Resource Types
+## barmancloud.cnpg.io/v1

+Package v1 contains API Schema definitions for the barmancloud v1 API group

- [ObjectStore](#barmancloud-cnpg-io-v1-ObjectStore)
-
-## ObjectStore     {#barmancloud-cnpg-io-v1-ObjectStore}
+### Resource Types
+- [ObjectStore](#objectstore)



-<p>ObjectStore is the Schema for the objectstores API.</p>
+#### InstanceSidecarConfiguration


-<table class="table">
-<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td><code>apiVersion</code> <B>[Required]</B><br/>string</td><td><code>barmancloud.cnpg.io/v1</code></td></tr>
-<tr><td><code>kind</code> <B>[Required]</B><br/>string</td><td><code>ObjectStore</code></td></tr>
-<tr><td><code>metadata</code> <B>[Required]</B><br/>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta"><i>meta/v1.ObjectMeta</i></a>
-</td>
-<td>
-   <span class="text-muted">No description provided.</span>Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field.</td>
-</tr>
-<tr><td><code>spec</code> <B>[Required]</B><br/>
-<a href="#barmancloud-cnpg-io-v1-ObjectStoreSpec"><i>ObjectStoreSpec</i></a>
-</td>
-<td>
-   <p>Specification of the desired behavior of the ObjectStore.
-More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status</p>
-</td>
-</tr>
-<tr><td><code>status</code><br/>
-<a href="#barmancloud-cnpg-io-v1-ObjectStoreStatus"><i>ObjectStoreStatus</i></a>
-</td>
-<td>
-   <p>Most recently observed status of the ObjectStore. This data may not be up to
-date. Populated by the system. Read-only.
-More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status</p>
-</td>
-</tr>
-</tbody>
-</table>

-## InstanceSidecarConfiguration     {#barmancloud-cnpg-io-v1-InstanceSidecarConfiguration}
+InstanceSidecarConfiguration defines the configuration for the sidecar that runs in the instance pods.


-**Appears in:**

- [ObjectStoreSpec](#barmancloud-cnpg-io-v1-ObjectStoreSpec)
+_Appears in:_
+- [ObjectStoreSpec](#objectstorespec)
+
+| Field | Description | Required | Default | Validation |
+| --- | --- | --- | --- | --- |
+| `env` _[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#envvar-v1-core) array_ | The environment to be explicitly passed to the sidecar |  |  |  |
+| `retentionPolicyIntervalSeconds` _integer_ | The retentionCheckInterval defines the frequency at which the<br />system checks and enforces retention policies. |  | 1800 |  |


-<p>InstanceSidecarConfiguration defines the configuration for the sidecar that runs in the instance pods.</p>
+#### ObjectStore


-<table class="table">
-<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td><code>env</code><br/>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core"><i>[]core/v1.EnvVar</i></a>
-</td>
-<td>
-   <p>The environment to be explicitly passed to the sidecar</p>
-</td>
-</tr>
-<tr><td><code>retentionPolicyIntervalSeconds</code><br/>
-<i>int</i>
-</td>
-<td>
-   <p>The retentionCheckInterval defines the frequency at which the
-system checks and enforces retention policies.</p>
-</td>
-</tr>
-</tbody>
-</table>

-## ObjectStoreSpec     {#barmancloud-cnpg-io-v1-ObjectStoreSpec}
+ObjectStore is the Schema for the objectstores API.


-**Appears in:**
-
- [ObjectStore](#barmancloud-cnpg-io-v1-ObjectStore)


-<p>ObjectStoreSpec defines the desired state of ObjectStore.</p>
+
+| Field | Description | Required | Default | Validation |
+| --- | --- | --- | --- | --- |
+| `apiVersion` _string_ | `barmancloud.cnpg.io/v1` | True | | |
+| `kind` _string_ | `ObjectStore` | True | | |
+| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | True |  |  |
+| `spec` _[ObjectStoreSpec](#objectstorespec)_ | Specification of the desired behavior of the ObjectStore.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status | True |  |  |
+| `status` _[ObjectStoreStatus](#objectstorestatus)_ | Most recently observed status of the ObjectStore. This data may not be up to<br />date. Populated by the system. Read-only.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |  |  |  |


-<table class="table">
-<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td><code>configuration</code> <B>[Required]</B><br/>
-<a href="https://pkg.go.dev/github.com/cloudnative-pg/barman-cloud/pkg/api/#BarmanObjectStoreConfiguration"><i>github.com/cloudnative-pg/barman-cloud/pkg/api.BarmanObjectStoreConfiguration</i></a>
-</td>
-<td>
-   <p>The configuration for the barman-cloud tool suite</p>
-</td>
-</tr>
-<tr><td><code>retentionPolicy</code><br/>
-<i>string</i>
-</td>
-<td>
-   <p>RetentionPolicy is the retention policy to be used for backups
-and WALs (i.e. '60d'). The retention policy is expressed in the form
-of <code>XXu</code> where <code>XX</code> is a positive integer and <code>u</code> is in <code>[dwm]</code> -
-days, weeks, months.</p>
-</td>
-</tr>
-<tr><td><code>instanceSidecarConfiguration</code><br/>
-<a href="#barmancloud-cnpg-io-v1-InstanceSidecarConfiguration"><i>InstanceSidecarConfiguration</i></a>
-</td>
-<td>
-   <p>The configuration for the sidecar that runs in the instance pods</p>
-</td>
-</tr>
-</tbody>
-</table>
-
-## ObjectStoreStatus     {#barmancloud-cnpg-io-v1-ObjectStoreStatus}
+#### ObjectStoreSpec


-**Appears in:**

- [ObjectStore](#barmancloud-cnpg-io-v1-ObjectStore)
+ObjectStoreSpec defines the desired state of ObjectStore.


-<p>ObjectStoreStatus defines the observed state of ObjectStore.</p>
+
+_Appears in:_
+- [ObjectStore](#objectstore)
+
+| Field | Description | Required | Default | Validation |
+| --- | --- | --- | --- | --- |
+| `configuration` _[BarmanObjectStoreConfiguration](https://pkg.go.dev/github.com/cloudnative-pg/barman-cloud/pkg/api#BarmanObjectStoreConfiguration)_ | The configuration for the barman-cloud tool suite | True |  |  |
+| `retentionPolicy` _string_ | RetentionPolicy is the retention policy to be used for backups<br />and WALs (i.e. '60d'). The retention policy is expressed in the form<br />of `XXu` where `XX` is a positive integer and `u` is in `[dwm]` -<br />days, weeks, months. |  |  | Pattern: `^[1-9][0-9]*[dwm]$` <br /> |
+| `instanceSidecarConfiguration` _[InstanceSidecarConfiguration](#instancesidecarconfiguration)_ | The configuration for the sidecar that runs in the instance pods |  |  |  |


-<table class="table">
-<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td><code>serverRecoveryWindow</code> <B>[Required]</B><br/>
-<a href="#barmancloud-cnpg-io-v1-RecoveryWindow"><i>map[string]RecoveryWindow</i></a>
-</td>
-<td>
-   <p>ServerRecoveryWindow maps each server to its recovery window</p>
-</td>
-</tr>
-</tbody>
-</table>
-
-## RecoveryWindow     {#barmancloud-cnpg-io-v1-RecoveryWindow}
+#### ObjectStoreStatus


-**Appears in:**

- [ObjectStoreStatus](#barmancloud-cnpg-io-v1-ObjectStoreStatus)
+ObjectStoreStatus defines the observed state of ObjectStore.


-<p>RecoveryWindow represents the time span between the first
+
+_Appears in:_
+- [ObjectStore](#objectstore)
+
+| Field | Description | Required | Default | Validation |
+| --- | --- | --- | --- | --- |
+| `serverRecoveryWindow` _object (keys:string, values:[RecoveryWindow](#recoverywindow))_ | ServerRecoveryWindow maps each server to its recovery window | True |  |  |
+
+
+#### RecoveryWindow
+
+
+
+RecoveryWindow represents the time span between the first
 recoverability point and the last successful backup of a PostgreSQL
-server, defining the period during which data can be restored.</p>
+server, defining the period during which data can be restored.
+
+
+
+_Appears in:_
+- [ObjectStoreStatus](#objectstorestatus)
+
+| Field | Description | Required | Default | Validation |
+| --- | --- | --- | --- | --- |
+| `firstRecoverabilityPoint` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#time-v1-meta)_ | The first recoverability point in a PostgreSQL server refers to<br />the earliest point in time to which the database can be<br />restored. | True |  |  |
+| `lastSuccussfulBackupTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#time-v1-meta)_ | The last successful backup time | True |  |  |


-<table class="table">
-<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td><code>firstRecoverabilityPoint</code> <B>[Required]</B><br/>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta"><i>meta/v1.Time</i></a>
-</td>
-<td>
-   <p>The first recoverability point in a PostgreSQL server refers to
-the earliest point in time to which the database can be
-restored.</p>
-</td>
-</tr>
-<tr><td><code>lastSuccussfulBackupTime</code> <B>[Required]</B><br/>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta"><i>meta/v1.Time</i></a>
-</td>
-<td>
-   <p>The last successful backup time</p>
-</td>
-</tr>
-</tbody>
-</table>
--- a/renovate.json5
+++ b/renovate.json5
@ -16,7 +16,7 @@
    "ignorePaths": [
      "dagger/gotest/go.mod",
      "dagger/e2e/go.mod"
-    ],
+    ]
  },
  "postUpdateOptions": [
    "gomodTidy"
@ -36,7 +36,19 @@
        "# renovate: datasource=(?<datasource>[a-z-.]+?) depName=(?<depName>[^\\s]+?)(?: (?:lookupName|packageName)=(?<packageName>[^\\s]+?))?(?: versioning=(?<versioning>[^\\s]+?))?(?: extractVersion=(?<extractVersion>[^\\s]+?))?(?: currentValue=(?<currentValue>[^\\s]+?))?\\s+[A-Za-z0-9_]+?_SHA\\s*:\\s*[\"']?(?<currentDigest>[a-f0-9]+?)[\"']?\\s",
        "# renovate: datasource=(?<datasource>[a-z-.]+?) depName=(?<depName>[^\\s]+?)(?: (?:lookupName|packageName)=(?<packageName>[^\\s]+?))?(?: versioning=(?<versioning>[^\\s]+?))?(?: extractVersion=(?<extractVersion>[^\\s]+?))?\\s+[A-Za-z0-9_]+?_VERSION\\s*:\\s*[\"']?(?<currentValue>.+?)[\"']?\\s"
      ]
-    }
+    },
+    {
+      "customType": "regex",
+      "fileMatch": [
+        "(^docs/config\\.yaml$)"
+      ],
+      "matchStrings": [
+        "# renovate: datasource=(?<datasource>[a-z-.]+?) depName=(?<depName>[^\\s]+?)(?: (?:lookupName|packageName)=(?<packageName>[^\\s]+?))?(?: versioning=(?<versioning>[^\\s]+?))?(?: extractVersion=(?<extractVersion>[^\\s]+?))?\\s+kubernetesVersion:\\s*[\"']?(?<currentValue>.+?)[\"']?\\s"
+      ],
+      // This is needed to limit renovate to update major.minor versions only. Having the patch breaks crd-ref-docs.
+      "versioningTemplate": "regex:(?<major>\\d+)\\.(?<minor>\\d+)",
+      "extractVersionTemplate": "^(?<version>v\\d+\\.\\d+)\\.\\d+$"
+    },
  ],
  "pip-compile": {
    "fileMatch": ["(^|/)sidecar-requirements\\.txt$"]