[otel registry] generate permalink for each entry

[atoulme]

The entries in the registry do not have a permalink. It would be nice to have a way to share a link to an entry in the registry with the registry card of the item.

[svrnm]

Agreed, it would be great to have that. In a previous version of the registry we had that since pages were generated from Markdown files, which unfortunately lead to the data drifting and pages having different formatting, that's why we migrated to a YML-based configuration.

With updates to hugo, we could have the best of both worlds with Content Adapters. I build a prototype for that a few months back, but the biggest hurdle is that this will generate 800+ additional pages significantly slowing down the build process for everyone.

We can work around that by adding some control over when those pages are built, i.e. only when one works with the registry and on production build.

Except there are better options, @chalin ?

[chalin]

I'd rather not generate new files if we can avoid it. I'd suggest finding a way to link to the entry in the registry. Each entry could have a unique ID that could be used as a hash. The ID could match the registry entry data file name, with the createdAt date appended. We'd have to update the search to support this. WDYT?

[mx-psi]

We could have a dedicated opentelemetry.io/registry/item#blob-that-refers-to-specific-entry and then some code to load the appropriate entry. That would not work without Javascript, but most of the usefulness of the registry comes from Javascript anyway.

[svrnm]

@chalin would it be possible with netlify/hugo redirects to do something like

https://opentelemetry.io/ecosystem/registry/entry-name to be redirected to https://opentelemetry.io/ecosystem/registry#component/entry-name, or maybe even https://registry.opentelemetry.io/component/entry-name ?

Adding the ID to each entry is probably the easy part, we only need to agree on the format :-)

[chalin]

I don't think that we need redirects either. Once we have IDs, a permalink would be something like https://opentelemetry.io/ecosystem/registry/?id=cloud-foundry-2025-05-05. Why would we need another format?

[svrnm]

I don't think that we need redirects either. Once we have IDs, a permalink would be something like opentelemetry.io/ecosystem/registry?id=cloud-foundry-2025-05-05. Why would we need another format?

If we ever move the registry off (which we hopefully do some beautiful day in the future) the collector SIG (and others) may need to change those links from their docs. This might not be in the initial issue description but if I understand @atoulme and @mx-psi correctly they consider adding a (back)link to the registry to the collector components?

Question: why would we add the date to the entry? For uniqueness?

[mx-psi]

if f I understand @atoulme and @mx-psi correctly they consider adding a (back)link to the registry to the collector components?

(Yes, that's the goal)