Compare commits

...

3 Commits

Author SHA1 Message Date
Krypton
46f138785b
Merge 4f83d5a60b into 08ab561429 2026-02-04 06:49:50 -06:00
Marco Nenciarini
08ab561429
docs(apidoc): filter Optional markers from validation column (#723)
Some checks failed
release-please / release-please (push) Failing after 4s
The crd-ref-docs tool v0.3.0 started rendering `+optional` Go markers as
`Optional: {}` in API documentation's validation column. This appeared
as redundant empty JSON objects since the Required column already
conveyed this information. The PR updates the documentation template to
filter these markers while keeping meaningful validation rules like
patterns and enums, and removes unnecessary customMarkers configuration.

Closes #722

Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
2026-02-04 13:46:51 +01:00
Krypton
4f83d5a60b
docs: add Helm chart installation
Signed-off-by: Krypton <root@krypton.ninja>
2026-01-05 21:05:05 +01:00
8 changed files with 76 additions and 5 deletions

View File

@ -86,7 +86,7 @@ tasks:
# renovate: datasource=git-refs depName=crd-gen-refs lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main
DAGGER_CRDGENREF_SHA: ee59e34a99940e45f87a16177b1d640975b05b74
# renovate: datasource=go depName=github.com/elastic/crd-ref-docs
CRDREFDOCS_VERSION: v0.2.0
CRDREFDOCS_VERSION: v0.3.0
cmds:
- >
GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/crd-ref-docs@${DAGGER_CRDGENREF_SHA}

View File

@ -1,9 +1,6 @@
processor:
ignoreGroupVersions:
- "GVK"
customMarkers:
- name: "optional"
target: field
ignoreFields:
# - "status$"
- "TypeMeta$"

View File

@ -31,7 +31,7 @@ _Appears in:_
{{ end -}}
{{ range $type.Members -}}
| `{{ .Name }}` _{{ markdownRenderType .Type }}_ | {{ template "type_members" . }} | {{ if not .Markers.optional -}}True{{- end }} | {{ markdownRenderDefault .Default }} | {{ range .Validation -}} {{ markdownRenderFieldDoc . }} <br />{{ end }} |
| `{{ .Name }}` _{{ markdownRenderType .Type }}_ | {{ template "type_members" . }} | {{ if not .Markers.optional -}}True{{- end }} | {{ markdownRenderDefault .Default }} | {{ range .Validation -}}{{- $v := markdownRenderFieldDoc . }}{{- if and $v (ne $v "Optional: \\{\\}") -}} {{ $v }} <br />{{ end }}{{- end }} |
{{ end -}}
{{ end -}}

View File

@ -56,6 +56,8 @@ Both checks are required before proceeding with the installation.
import { InstallationSnippet } from '@site/src/components/Installation';
### Directly using the manifest
Install the plugin using `kubectl` by applying the manifest for the latest
release:
@ -98,6 +100,18 @@ deployment "barman-cloud" successfully rolled out
This confirms that the plugin is deployed and ready to use.
### Using the Helm Chart
The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud):
```sh
helm repo add cnpg https://cloudnative-pg.github.io/charts
helm upgrade --install barman-cloud \
--namespace cnpg-system \
--create-namespace \
cnpg/plugin-barman-cloud
```
## Testing the latest development snapshot
You can also test the latest development snapshot of the plugin with the

View File

@ -56,6 +56,8 @@ Both checks are required before proceeding with the installation.
import { InstallationSnippet } from '@site/src/components/Installation';
### Directly using the manifest
Install the plugin using `kubectl` by applying the manifest for the latest
release:
@ -98,6 +100,19 @@ deployment "barman-cloud" successfully rolled out
This confirms that the plugin is deployed and ready to use.
### Using the Helm Chart
The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud):
```sh
helm repo add cnpg https://cloudnative-pg.github.io/charts
helm upgrade --install barman-cloud \
--namespace cnpg-system \
--create-namespace \
--version 0.4.0 \
cnpg/plugin-barman-cloud
```
## Testing the latest development snapshot
You can also test the latest development snapshot of the plugin with the

View File

@ -56,6 +56,8 @@ Both checks are required before proceeding with the installation.
import { InstallationSnippet } from '@site/src/components/Installation';
### Directly using the manifest
Install the plugin using `kubectl` by applying the manifest for the latest
release:
@ -98,6 +100,19 @@ deployment "barman-cloud" successfully rolled out
This confirms that the plugin is deployed and ready to use.
### Using the Helm Chart
The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud):
```sh
helm repo add cnpg https://cloudnative-pg.github.io/charts
helm upgrade --install barman-cloud \
--namespace cnpg-system \
--create-namespace \
--version 0.1.0 \
cnpg/plugin-barman-cloud
```
## Testing the latest development snapshot
You can also test the latest development snapshot of the plugin with the

View File

@ -56,6 +56,8 @@ Both checks are required before proceeding with the installation.
import { InstallationSnippet } from '@site/src/components/Installation';
### Directly using the manifest
Install the plugin using `kubectl` by applying the manifest for the latest
release:
@ -98,6 +100,19 @@ deployment "barman-cloud" successfully rolled out
This confirms that the plugin is deployed and ready to use.
### Using the Helm Chart
The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud):
```sh
helm repo add cnpg https://cloudnative-pg.github.io/charts
helm upgrade --install barman-cloud \
--namespace cnpg-system \
--create-namespace \
--version 0.2.0 \
cnpg/plugin-barman-cloud
```
## Testing the latest development snapshot
You can also test the latest development snapshot of the plugin with the

View File

@ -56,6 +56,8 @@ Both checks are required before proceeding with the installation.
import { InstallationSnippet } from '@site/src/components/Installation';
### Directly using the manifest
Install the plugin using `kubectl` by applying the manifest for the latest
release:
@ -98,6 +100,19 @@ deployment "barman-cloud" successfully rolled out
This confirms that the plugin is deployed and ready to use.
### Using the Helm Chart
The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud):
```sh
helm repo add cnpg https://cloudnative-pg.github.io/charts
helm upgrade --install barman-cloud \
--namespace cnpg-system \
--create-namespace \
--version 0.3.1 \
cnpg/plugin-barman-cloud
```
## Testing the latest development snapshot
You can also test the latest development snapshot of the plugin with the