crd-ref-docs

crd-ref-docs copied to clipboard

Move Kubernetes API types to the top

1

Something I'm observing from my https://github.com/ahmetb/gen-crd-api-reference-docs tool that's not ported here is that this tool is showing headings for various Go types referred in my Kubernetes custom resource types on...

ahmetb

When generating docs for the operator with mutliple CRDs in different paths, it would be nice to specify multiple source paths. For ex, in the following folder structure - ```...

padlar

Generated link to Kubernetes API is wrong

1

Hi, I'm rendering an API resource with the following piece in it: ``` RoleRef rbacv1.RoleRef `json:"roleRef"` ``` which references to upstream's Role Reference as used in the ClusterRoleBinding resource. That...

wmuizelaar

Welcome to [Renovate](https://togithub.com/renovatebot/renovate)! This is an onboarding PR to help you understand and configure settings before regular Pull Requests begin. 🚦 To activate Renovate, merge this Pull Request. To disable...

elastic-renovate-prod[bot]

Minor markdown improvements

2

This fixes three issues I bumped into when trying to generate our docs: 1) adds version to generated file names in group-mode - to avoid files overwriting each-other 2) escapes...

olensmar

showcase issues with overriding k8s api links

1

mowies

I am trying to override a link to the Quanity type from `k8s.io/apimachinery/pkg/api/resource` ([Link](https://github.com/keptn/lifecycle-toolkit/blob/b1dd064934b9bf5654cac0b948dcc0ff6ad2b39b/.github/scripts/generate-crd-docs/crd-docs-generator-config.yaml#L15-L17)). But the generator is not respecting my config at all and uses the built-in k8s generated...

mowies

### Problem statement When a version that ends with `0` like `1.30` is used in the config e.g. ``` render: kubernetesVersion: 1.30 ``` then it will be truncated like a...

pmalek

In an internal documentation I have a file exists per resource/kind, so it would be nice to output the API references for each kind. Example: ``` $ crd-ref-docs --source-path=./pkg/apis \...

akselleirv

fix(deps): update module sigs.k8s.io/controller-tools to v0.16.3

1

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [sigs.k8s.io/controller-tools](https://togithub.com/kubernetes-sigs/controller-tools) | require | minor | `v0.14.0` -> `v0.16.3` | --- ### Release...

elastic-renovate-prod[bot]