Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align types for observability side navigation registration #103325

Open
smith opened this issue Jun 24, 2021 · 0 comments
Open

Align types for observability side navigation registration #103325

smith opened this issue Jun 24, 2021 · 0 comments
Labels
Team:Observability Team label for Observability Team (for things that are handled across all of observability)

Comments

@smith
Copy link
Contributor

smith commented Jun 24, 2021

When registering deep links for an application (to be shown in the global side nav and to show up in global search) using ApplicationSetup.register, the deepLinks are of type AppDeepLink which takes id, title, order, path, and navLinkStatus, among other properties.

When registering sections to be shown in the Observability-specific navigation using navigationRegistry.registerSections the section entries are of type NavigationEntry, which takes label, app, path, among other properties.

If you're registering the same items as deep links are your are navigation sections, it's a bit tedious to convert title to label, etc.

There could be cases where you want different things for deep links and navigation sections, so it may not make sense for these to all be one method call, but we could better align the types to make it easier to share the definitions.

@smith smith added the Team:Observability Team label for Observability Team (for things that are handled across all of observability) label Jun 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Observability Team label for Observability Team (for things that are handled across all of observability)
Projects
None yet
Development

No branches or pull requests

1 participant