Add auto-generated API documentation using crd-ref-docs

[ArangoGutierrez]

What this PR does

This PR addresses issue #2090 by adding auto-generated API reference documentation for the NFD CRDs using elastic/crd-ref-docs.

Changes

• Add Makefile target generate-api-docs to generate API documentation
• Add crd-ref-docs configuration at hack/crd-ref-docs/config.yaml
• Generate initial API reference for api/nfd/v1alpha1 at docs/reference/nfd-api-reference.md

Usage

Regenerate API docs anytime with:

make generate-api-docs

Generated Documentation

The generated documentation includes all NFD Custom Resource types:

• NodeFeature / NodeFeatureSpec
• NodeFeatureRule / NodeFeatureRuleSpec / Rule
• NodeFeatureGroup / NodeFeatureGroupSpec / GroupRule
• Supporting types: FeatureMatcher, MatchExpression, etc.

Note

The api/image-compatibility types are not Kubernetes CRDs (they lack +kubebuilder markers), so crd-ref-docs doesn't generate documentation for them. If documentation is needed for those types, a different approach would be required.

/kind documentation

[netlify]

✅ Deploy Preview for kubernetes-sigs-nfd ready!

Name	Link
🔨 Latest commit	0797c5d
🔍 Latest deploy log	https://app.netlify.com/projects/kubernetes-sigs-nfd/deploys/696a8bcff0f8670007f1ced4
😎 Deploy Preview	https://deploy-preview-2417--kubernetes-sigs-nfd.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ArangoGutierrez

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [ArangoGutierrez]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[ArangoGutierrez]

/assign @marquiz

[k8s-ci-robot]

@ArangoGutierrez: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-node-feature-discovery-build-image-cross-generic	0797c5d	link	true	/test pull-node-feature-discovery-build-image-cross-generic

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.