Intro tutorials for About API use cases

lauralorenz commented 1 year ago

Develop some vendor agnostic intro tutorials about the About API that can be easily digested as part of a generic documentation push. I think it would be useful to tie them to some common use cases as suggested below.

About API for storing cluster name and sending as prometheus label in your metrics instrumentation
About API for storing arbitrary, implementation specific cluster properties following the rules listed here and discussed on this slide, possibly a cluster's network name, region, etc

lauralorenz commented 1 year ago

/help

k8s-ci-robot commented 1 year ago

@lauralorenz: This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

Why are we solving this issue?
To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
Does this issue have zero to low barrier of entry?
How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-help command.

In response to [this](https://github.com/kubernetes-sigs/about-api/issues/13): >/help Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

kubernetes-sigs / about-api

Intro tutorials for About API use cases #13

Guidelines