Merge 90dbe03a74 into 08ab561429

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>

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,126 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: ["triage", "bug"]
+projects: ["coudnative-pg/plugin-barman-cloud"]
+# assignees:
+#   - gbartolini
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report for the BarmanCloudPlugin!
+  - type: checkboxes
+    id: search
+    attributes:
+      label: Is there an existing issue already for this bug?
+      description: Before you submit a bug, make sure you have searched if a similar one already exists
+      options:
+        - label: I have searched for an existing issue, and could not find anything. I believe this is a new bug.
+          required: true
+  # - type: checkboxes
+  #   id: troubleshooting
+  #   attributes:
+  #     label: I have read the troubleshooting guide
+  #     description: Before you submit a bug, make sure you have read the ["Common issues" section in the Troubleshooting guide](https://cloudnative-pg.io/documentation/current/troubleshooting/#some-common-issues).
+  #     options:
+  #       - label: I have read the troubleshooting guide and I think this is a new bug.
+  #         required: true
+  # - type: checkboxes
+  #   id: supported
+  #   attributes:
+  #     label: I am running a supported version of CloudNativePG
+  #     description: Before you submit a bug, make sure you have read ["Supported releases"](https://cloudnative-pg.io/documentation/current/supported_releases/) and that you are running a supported version of CloudNativePG with the latest patch/security fixes, or you are working on the current trunk (`main` branch)
+  #     options:
+  #       - label: I have read the troubleshooting guide and I think this is a new bug.
+  #         required: true
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details
+      description: How can we get in touch with you if we need more info?
+      placeholder: ex. email@example.com
+    validations:
+      required: false
+  - type: dropdown
+    id: version
+    attributes:
+      label: Version
+      description: What is the version of the BarmanCloudPlugin you are running?
+      options:
+        - "0.5.1"             
+        - "0.5.0"    
+        - "0.4.1"                               
+        - "0.4.0"         
+        - "0.3.0"            
+        - "0.2.0"      
+        - "0.1.0"
+    validations:
+      required: true
+  - type: dropdown
+    id: k8s_version
+    attributes:
+      label: What version of Kubernetes are you using?
+      options:
+        - "1.32"
+        - "1.31"
+        - "1.30"
+        - "1.29"
+        - "other (unsupported)"
+    validations:
+      required: true
+  - type: dropdown
+    id: k8s_environment
+    attributes:
+      label: What is your Kubernetes environment?
+      options:
+        - "Self-managed: kind (evaluation)"
+        - "Self-managed: k0s"
+        - "Self-managed: k3s"
+        - "Self-managed: RKE"
+        - "Cloud: Amazon EKS"
+        - "Cloud: Google GKE"
+        - "Cloud: Azure AKS"
+        - "Cloud: Other"
+        - "Other"
+    validations:
+      required: true
+  - type: dropdown
+    id: installation_method
+    attributes:
+      label: How did you install the BarmanCloudPlugin?
+      options:
+        - "YAML manifest"
+        # - "Helm"
+        # - "OLM"
+        - "Other"
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+    validations:
+      required: true
+  - type: textarea
+    id: spec
+    attributes:
+      label: Cluster resource
+      description: Please copy and paste the CR of the cluster
+      render: shell
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/cloudnative-pg/governance/blob/main/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  # - name: Open discussions
+  #   url: https://github.com/cloudnative-pg/cloudnative-pg/discussions
+  #   about: Please ask and answer questions here.
+  - name: Slack chat
+    url: https://github.com/cloudnative-pg/cloudnative-pg?tab=readme-ov-file#communications
+    about: Please join the slack channel and interact with our community

.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,74 @@
+name: Documentation
+description: Issues or improvement ideas for the plugin-barman-cloud documentation
+title: "[Docs]: "
+labels: ["triage", "documentation"]
+projects: ["coudnative-pg/plugin-barman-cloud"]
+# assignees:
+#   - gbartolini
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time improve the documentation of the BarmanCloudPlugin!
+  - type: checkboxes
+    id: search
+    attributes:
+      label: Is there an existing issue already for your request/idea?
+      description: Before you submit a new issue, make sure you have searched if a similar one already exists
+      options:
+        - label: I have searched for an existing issue, and could not find anything. I believe this is a new documentation enhancement to be evaluated.
+          required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: What problem in the existing documentation this issue aims to solve?
+      description: A clear and concise description of what the problem is (e.g. I'm always frustrated when [...])
+    validations:
+      required: true
+  - type: textarea
+    id: doc_add
+    attributes:
+      label: Describe what additions need to be done to the documentation
+      description: A clear and concise description of what sections/pages you want to add to the current documentation.
+    validations:
+      required: false
+  - type: textarea
+    id: doc_change
+    attributes:
+      label: Describe what pages need to change in the documentation, if any
+      description: Please provide links to the pages in the current documentation
+    validations:
+      required: false
+  - type: textarea
+    id: doc_remove
+    attributes:
+      label: Describe what pages need to be removed from the documentation, if any
+      description: Please provide links to the pages in the current documentation that you want to be removed
+    validations:
+      required: false
+  - type: textarea
+    id: additional_context
+    attributes:
+      label: Additional context
+      description: Add any other context about this issue.
+    validations:
+      required: false
+  - type: dropdown
+    id: backport
+    attributes:
+      label: Backport?
+      description: Do you suggest to backport this feature or not?
+      options:
+        - "Yes"
+        - "No"
+        - "N/A"
+    validations:
+      required: true
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/cloudnative-pg/governance/blob/main/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,77 @@
+name: Feature request
+description: Suggest an idea or request a new feature for the plugin-barman-cloud
+title: "[Feature]: "
+labels: ["triage", "enhancement"]
+projects: ["coudnative-pg/plugin-barman-cloud"]
+# assignees:
+#   - gbartolini
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to propose new ideas and feature requests to the BarmanCloudPlugin!
+  - type: checkboxes
+    id: search
+    attributes:
+      label: Is there an existing issue already for this feature request/idea?
+      description: Before you submit a new feature request, make sure you have searched if a similar one already exists
+      options:
+        - label: I have searched for an existing issue, and could not find anything. I believe this is a new feature request to be evaluated.
+          required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: What problem is this feature going to solve? Why should it be added?
+      description: A clear and concise description of what the problem is (e.g. I'm always frustrated when [...])
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: true
+  - type: textarea
+    id: additional_context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false
+  - type: dropdown
+    id: backport
+    attributes:
+      label: Backport?
+      description: Do you suggest to backport this feature or not?
+      options:
+        - "Yes"
+        - "No"
+        - "N/A"
+    validations:
+      required: true
+  - type: dropdown
+    id: contribute
+    attributes:
+      label: Are you willing to actively contribute to this feature?
+      description: Let us know if you are interested in developing this feature.
+      options:
+        - "No"
+        - "Yes"
+    validations:
+      required: true
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/cloudnative-pg/governance/blob/main/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/release-notes.yml

@@ -0,0 +1,48 @@
+name: Release Notes
+description: Release notes for a new version of the BarmanCloudPlugin
+title: "[Release Notes]: BarmanCloudPlugin 1.XX.Y and 1.XX-1.Z"
+labels: ["triage", "documentation"]
+projects: ["coudnative-pg/plugin-barman-cloud"]
+# assignees:
+#   - gbartolini
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Make sure that the correct versions are reported in the title of the ticket.
+  - type: checkboxes
+    id: search
+    attributes:
+      label: Is there an existing issue already for this task?
+      description: Before you submit a new issue, make sure you have searched if a similar one already exists
+      options:
+        - label: I have searched for an existing issue, and could not find anything. I believe this is a new request.
+          required: true
+  - type: dropdown
+    id: minor
+    attributes:
+      label: Is this a new minor release?
+      description: Is this a new minor release for the BarmanCloudPlugin?
+      options:
+        - "No"
+        - "Yes"
+    validations:
+      required: true
+  - type: dropdown
+    id: preview
+    attributes:
+      label: Is this a preview release?
+      description: Is this a preview release for the BarmanCloudPlugin? If so, make sure you add `-RC1` to the version and update the `preview_version.md` file.
+      options:
+        - "No"
+        - "Yes"
+    validations:
+      required: true
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/cloudnative-pg/governance/blob/main/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

Taskfile.yml

@@ -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}

hack/crd-gen-refs/config.yaml

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

hack/crd-gen-refs/markdown/type.tpl

@@ -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 -}}