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

[Telemetry] Complete the API docs #98516

Closed
afharo opened this issue Apr 27, 2021 · 2 comments · Fixed by #98610
Closed

[Telemetry] Complete the API docs #98516

afharo opened this issue Apr 27, 2021 · 2 comments · Fixed by #98610
Assignees
@afharo
Labels
enhancement New value added to drive a business result Feature:Telemetry Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@afharo
Copy link
Member

afharo commented Apr 27, 2021 •
edited
Loading

After #98338 is done, when running node scripts/build_api_docs.js --plugin telemetry --stats exports, we get the following output.

 info --- Plugin 'telemetry' ----`
 info 1 API items with ANY
 info 78 API items missing comments

We need to add comments to the exposed APIs so they are properly documented.

To identify those missing comments, we can run node scripts/build_api_docs --plugin telemetry --stats comments
@afharo afharo added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc enhancement New value added to drive a business result Feature:Telemetry Team:KibanaTelemetry labels Apr 27, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-telemetry (Team:KibanaTelemetry)

@elasticmachine
Copy link
Contributor

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

@afharo afharo mentioned this issue Apr 28, 2021
Merged
2 tasks
@afharo afharo self-assigned this Apr 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@afharo afharo

Labels
enhancement New value added to drive a business result Feature:Telemetry Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[API DOCS] Telemetry afharo/kibana
3 participants
@lukeelmers @afharo @elasticmachine