Skip to content

Create more registries#2146

Closed
jsuereth wants to merge 9 commits intoopen-telemetry:mainfrom
jsuereth:wip-more-than-attributes-registry
Closed

Create more registries#2146
jsuereth wants to merge 9 commits intoopen-telemetry:mainfrom
jsuereth:wip-more-than-attributes-registry

Conversation

@jsuereth
Copy link
Copy Markdown
Contributor

Reworks our registry generation so we have a registry we can provide links to for both attributes and entities.

Merge requirement checklist




# Aws Log
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: acronym filter




# Aws Ecs
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

leaving comment here, but it's a general question:

what would we do for metrics/events/spans in the future - would we group them by the root namespace or render each in a separate file?

I think it makes sense to group them (e.g. all HTTP metrics in one doc) - having one per file feels too granular. But that's what we generate here and it matches current resource docs layout

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah - I think having one per file DOES make a lot of sense. I can update the entity registry to do that too.

<thead>
<tr>
<th>Namespace</th>
<th>Entity</th>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe

Suggested change
<th>Entity</th>
<th>Entities</th>

?

The rendering is a bit weird

image

so it took me a bit to understand there could be more than one, so maybe plural would be a bit more clear?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah - I'm still toying with making this look good. This is a prototype that SHOULD be just enough wrong it give speople a good idea of what it should be :).

Agree it could be called Entities, but if you have other ideas for how to organize the information, I'm all ears.

Copy link
Copy Markdown
Member

@trask trask left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do you think about renaming

/docs/attributes-registry --> /docs/registry/attribute/

in a separate PR first, to make it easier to review the mass mechanical changes separately?

@jsuereth
Copy link
Copy Markdown
Contributor Author

what do you think about renaming

/docs/attributes-registry --> /docs/registry/attribute/

in a separate PR first, to make it easier to review the mass mechanical changes separately?

Of course. This is a "demo" of what we could do, hence it's still draft. I'd like to align on what we think "looks right" and then do all the updates.

The Website changes in this PR are also somewhat dubious, but hard to showcase without importing this PR into the opentelemetry.io project to show it off...

@jsuereth
Copy link
Copy Markdown
Contributor Author

what do you think about renaming

/docs/attributes-registry --> /docs/registry/attribute/

in a separate PR first, to make it easier to review the mass mechanical changes separately?

Opened a PR for this now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants