Append reference links to metric descriptions in metadata.yaml

[raunaqgupta]

Description

This PR aims to append reference links to metric descriptions in receiver/k8sclusterreceiver/metadata.yaml to sections within the k8s API reference v1.23

This is in accordance to existing links in descriptions of certain metrics. For example:

opentelemetry-collector-contrib/receiver/k8sclusterreceiver/metadata.yaml

Line 214 in 4ab35b1

description: Resource requested for the container. See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#resourcerequirements-v1-core for details

[atoulme]

You might need to regenerate the code. Try make generate from the root of your checkout.

[atoulme]

Moving to draft while you address the feedback.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: raunaqgupta / name: rawknuckles (e100a35, d17b5cb, 153872b, ae2eb5e, 4ab35b1)

[povilasv]

Tests are failing:

    e2e_test.go:180: 
        	Error Trace:	/home/runner/work/opentelemetry-collector-contrib/opentelemetry-collector-contrib/receiver/k8sclusterreceiver/e2e_test.go:181
        	            				/opt/hostedtoolcache/go/1.23.8/x64/src/runtime/asm_amd64.s:1700
        	Error:      	Received unexpected error:
        	            	the following errors occurred:
        	            	 -  resource "map[k8s.hpa.name:test-k8scluster-receiver-hpa k8s.hpa.uid:* k8s.namespace.name:my-namespace]": scope "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver": metric "k8s.hpa.current_replicas": description doesn't match expected: Current number of pod replicas managed by this autoscaler., actual: Current number of pod replicas managed by this autoscaler. See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.33/#horizontalpodautoscalerstatus-v1-autoscaling for details.
        	            	 -  resource "map[k8s.hpa.name:test-k8scluster-receiver-hpa k8s.hpa.uid:* k8s.namespace.name:my-namespace]": scope "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver": metric "k8s.hpa.desired_replicas": description doesn't match expected: Desired number of pod replicas managed by this autoscaler., actual: Desired number of pod replicas managed by this autoscaler. See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.33/#horizontalpodautoscalerstatus-v1-autoscaling for details.
        	            	 -  resource "map[k8s.hpa.name:test-k8scluster-receiver-hpa k8s.hpa.uid:* k8s.namespace.name:my-namespace]": scope "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver": metric "k8s.hpa.max_replicas": description doesn't match expected: Maximum number of replicas to which the autoscaler can scale up., actual: Maximum number of replicas to which the autoscaler can scale up. See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.33/#horizontalpodautoscalerspec-v1-autoscaling for details.
        	            	 -  resource "map[k8s.hpa.name:test-k8scluster-receiver-hpa k8s.hpa.uid:* k8s.namespace.name:my-namespace]": scope "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver": metric "k8s.hpa.min_replicas": description doesn't match expected: Minimum number of replicas to which the autoscaler can scale up., actual: Minimum number of replicas to which the autoscaler can scale up. See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.33/#horizontalpodautoscalerspec-v1-autoscaling for details.
    e2e_test.go:180: 
    ```
    
    You need to update e2e too 

[raunaqgupta]

@raunaqgupta Update file: receiver/k8sclusterreceiver/testdata/e2e/cluster-scoped/expected.yaml to fix failing e2e tests

[github-actions]

This PR was marked stale due to lack of activity. It will be closed in 14 days.