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

[Usage Collection] MDX documentation #92193

Closed
afharo opened this issue Feb 22, 2021 · 9 comments
Closed

[Usage Collection] MDX documentation #92193

afharo opened this issue Feb 22, 2021 · 9 comments
Assignees
Labels
docs Feature:Telemetry Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@afharo
Copy link
Member

afharo commented Feb 22, 2021

Let's improve the documentation by converting https://github.com/elastic/kibana/blob/master/src/plugins/usage_collection/README.md to MDX.

Also, let's create some example plugins using the collection APIs to showcase them and how they should be used.

@afharo afharo added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:Telemetry labels Feb 22, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

@afharo afharo added the docs label Feb 22, 2021
@afharo
Copy link
Member Author

afharo commented Feb 23, 2021

Let's create another issue for the examples :)

@TinaHeiligers
Copy link
Contributor

@afharo what usage collection APIs do you want to showcase and should we add a new example plugin for each of them?
Maybe we can group the usage collectors we decide to use into an example (maybe a server-side and client side collector) and then add some sort of a minimal UI to show the data itself.

@afharo
Copy link
Member Author

afharo commented Feb 24, 2021

I think the examples should show how each of the APIs exposed by the Usage Collection service work.

Maybe it can be just 1 example plugin making use of all of them (properly commenting the code to explain them?). What do you think? Would it be too messy?

@TinaHeiligers
Copy link
Contributor

TinaHeiligers commented Feb 24, 2021

What do you think? Would it be too messy?

@afharo I've added a new issue for adding example(s). We can chat about the design and what we want to showcase in there.
Examples are an enhancement so there's no real rush for that. We can start small and iterate on that.

@afharo
Copy link
Member Author

afharo commented Mar 10, 2021

@TinaHeiligers do you think we can close this issue? It looks like the PR converting the README to .mdx was merged :)

@TinaHeiligers
Copy link
Contributor

It looks like the PR converting the README to .mdx was merged

The conversion to .mdx only partially addressed this issue request. We still need to add examples.

@afharo
Copy link
Member Author

afharo commented Mar 11, 2021

AFAIK, we've got #92668 to track the examples effort. Does it make sense if we update the title to remove the + examples bit and close it?

@TinaHeiligers TinaHeiligers changed the title [Usage Collection] MDX documentation + examples [Usage Collection] MDX documentation Mar 15, 2021
@TinaHeiligers
Copy link
Contributor

closed with #92982

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Feature:Telemetry Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Development

No branches or pull requests

3 participants