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.

Sign up for GitHub

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

Jump to bottom

[Observability UI] Document shared telemetry hooks #73482

Open
jasonrhodes opened this issue Jul 28, 2020 · 0 comments
Open

[Observability UI] Document shared telemetry hooks #73482

jasonrhodes opened this issue Jul 28, 2020 · 0 comments
Assignees
@jasonrhodes
Labels
docs Team:Observability Team label for Observability Team (for things that are handled across all of observability)

Comments

@jasonrhodes
Copy link
Member

Create markdown docs for how to access, set up, and use the shared hooks.

It should be clear:

  • How to access the components and hooks, along with any required deps
  • How to call the functions, know what params they take and what they do/return

These should be added to a markdown file at the root of the plugin (README.md? DOCS.md?)
@jasonrhodes jasonrhodes added Team:Observability Team label for Observability Team (for things that are handled across all of observability) docs labels Jul 28, 2020
@jasonrhodes jasonrhodes self-assigned this Jul 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jasonrhodes jasonrhodes

Labels
docs Team:Observability Team label for Observability Team (for things that are handled across all of observability)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jasonrhodes