search

giantswarm / docs

The Giant Swarm documentation site
http://docs.giantswarm.io
Apache License 2.0
4 stars 8 forks source link

Add labels and annotations reference stub #2159

Open marians opened 6 months ago

marians commented 6 months ago

Towards https://github.com/giantswarm/roadmap/issues/3295

This PR collects reference content about Kubernetes resource labels and annotations we add or we rely on. It is to be merged into the new /reference/ section which is expected to be added with https://github.com/giantswarm/docs/pull/2129.

When adding content to this branch, please create a PR. Some guidelines:

pipo02mix commented 3 weeks ago

@marians what do you think about merging as it is?

marians commented 2 days ago

@pipo02mix Yes, I'd be ready for that. Do you want to give it an approval?

pipo02mix commented 1 day ago

But we still have several labels with TODOs; can we comment out those?

Another point, I don't like k8s-metadata as path. What if we set it under /platform-api/ since it is part of the resources we will place there?

marians commented 1 day ago

But we still have several labels with TODOs; can we comment out those?

You tricked me! ;-) I thought you think we could merge it as it is. Anyway, I'll take care.

Another point, I don't like k8s-metadata as path. What if we set it under /platform-api/ since it is part of the resources we will place there?

I think it definitely belongs to "reference", but there is no sub-folder "platform-api" yet in there, and I don't want to create a too deep structure right now. Once there is more content, I vote for moving k8s-metadata into a sub folder. I do think that annotations and labels are very similar concepts (loosely defined conventions instead of strict API) that fit well into a common subfolder. WDYT?