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

[DOCS] Usage Collection: better landing docs for improved DX #88500

Merged
merged 5 commits into from
Jan 20, 2021
Merged

[DOCS] Usage Collection: better landing docs for improved DX #88500

merged 5 commits into from
Jan 20, 2021

Conversation

afharo
Copy link
Member

@afharo afharo commented Jan 15, 2021 •
edited
Loading

Summary

During conversations with @thesmallestduck and @alexfrancoeur, we noticed we don't have a clear landing page for devs to know about the state-of-the-art collectors they can benefit from.

This PR aims to refactor the Usage Collection README so it becomes a useful "Getting Started" guide for devs.

Checklist

Delete any items that are not applicable to this PR.

  • Documentation was added for features that require explanation or tutorials

For maintainers

@afharo afharo added Feature:Telemetry release_note:skip Skip the PR/issue when compiling release notes v7.12.0 labels Jan 15, 2021
@afharo afharo requested a review from a team as a code owner January 15, 2021 18:30
afharo
afharo commented Jan 15, 2021
View reviewed changes
src/plugins/usage_collection/README.md
### `public` APIs

The APIs exposed in the `public` context aim to collect the _aggregate_ number of events that occur in a period of time. They are **not** intended for user-behavioural tracking. The APIs available can be categorized in 2: Application Usage and UI Counters.

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe we can add to the public APIs the UI Settings collector as well? Should we do it now or once we finish up #85811?

@afharo
Copy link
Member Author

afharo commented Jan 15, 2021

@elasticmachine merge upstream

@afharo
Copy link
Member Author

afharo commented Jan 18, 2021

@elasticmachine merge upstream

Bamieh
Bamieh approved these changes Jan 19, 2021
View reviewed changes
Copy link
Member

@Bamieh Bamieh left a comment

Choose a reason for hiding this comment

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

LGTM. i read the whole README and not only the changes. overall it looks very approachable and well formed. Thanks!

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@afharo afharo merged commit fc9da67 into elastic:master Jan 20, 2021
@afharo afharo deleted the usage_collection/better_docs branch January 20, 2021 11:33
@afharo afharo mentioned this pull request Jan 20, 2021
Merged
afharo added a commit that referenced this pull request Jan 20, 2021
@afharo @kibanamachine
[7.x] [DOCS] Usage Collection: better landing docs for improved DX (#…
a6a9570 
…88500) (#88821)

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Bamieh Bamieh Bamieh approved these changes

@TinaHeiligers TinaHeiligers Awaiting requested review from TinaHeiligers

@thesmallestduck thesmallestduck Awaiting requested review from thesmallestduck

@alexfrancoeur alexfrancoeur Awaiting requested review from alexfrancoeur

Assignees
No one assigned
Labels
Feature:Telemetry release_note:skip Skip the PR/issue when compiling release notes v7.12.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@afharo @kibanamachine @Bamieh