Skip to content

[editorial] Rename resource/k8s/k8s.md to resource/k8s/README.md#2917

Merged
joaopgrassi merged 1 commit intoopen-telemetry:mainfrom
chalin:chalin-m24-k8s-rsrc-index-2025-1015
Oct 15, 2025
Merged

[editorial] Rename resource/k8s/k8s.md to resource/k8s/README.md#2917
joaopgrassi merged 1 commit intoopen-telemetry:mainfrom
chalin:chalin-m24-k8s-rsrc-index-2025-1015

Conversation

@chalin
Copy link
Copy Markdown
Contributor

@chalin chalin commented Oct 15, 2025

@joaopgrassi
Copy link
Copy Markdown
Member

joaopgrassi commented Oct 15, 2025

What about we add a README.md (docs/resource/k8s/README.md) ? Then we can just use that as the entry point for both the k8s.md and openshift.md. With something like:


Container orchestration

Status: Development

This document defines semantic conventions for resource in container orchestration systems.

  • K8s: Semantic Conventions for K8s.
  • OpenShift: Semantic Conventions for OpenShift.

@joaopgrassi joaopgrassi added the Skip Changelog Label to skip the changelog check label Oct 15, 2025
@chalin
Copy link
Copy Markdown
Contributor Author

chalin commented Oct 15, 2025

What about we add a README.md (docs/resource/k8s/README.md) ? Then we can just use that as the entry point for both the k8s.md and openshift.md. With something like:

Sure, that works, if it is what you prefer. It's just that what you propose feels a bit less natural. E.g., you write "conventions for resource in K8s" twice: once for the landing page and then again for a subpage. WDYT?

@joaopgrassi
Copy link
Copy Markdown
Member

joaopgrassi commented Oct 15, 2025

Yeah maybe we have the landing page with "Container Orchestration" instead :). Fixed the example above.

@chalin
Copy link
Copy Markdown
Contributor Author

chalin commented Oct 15, 2025

Yeah maybe we have the landing page with "Container Orchestration" instead :). Fixed the example above.

@joaopgrassi - hmm, but then the folder name should be changed too? So rename the k8s folder to, say, container? Otherwise, I can't create a redirect for the moved k8s page. If I try, it creates a loop for the index page.

If the section really is about k8s resources, then I think the change proposed in this PR is probably best. But I defer to you.

@joaopgrassi
Copy link
Copy Markdown
Member

Alright, let's keep your suggestion then, and we can revisit later if necessary.

@joaopgrassi joaopgrassi moved this from Untriaged to Needs More Approval in Semantic Conventions Triage Oct 15, 2025
@trisch-me
Copy link
Copy Markdown
Contributor

@joaopgrassi I like your idea of having page with links to k8s and openshift but let’s first merge as is to unblock

@joaopgrassi joaopgrassi added this pull request to the merge queue Oct 15, 2025
@joaopgrassi joaopgrassi moved this from Needs More Approval to Ready to be Merged in Semantic Conventions Triage Oct 15, 2025
Merged via the queue into open-telemetry:main with commit 19a8b95 Oct 15, 2025
15 of 16 checks passed
@chalin chalin deleted the chalin-m24-k8s-rsrc-index-2025-1015 branch October 15, 2025 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skip Changelog Label to skip the changelog check

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

[editorial] Rename of docs/resource/k8s.md might be wrong. It also needs an alias to avoid 404s

3 participants