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

[Meta] Core documentation backlog #96592

Closed
5 of 11 tasks
TinaHeiligers opened this issue Apr 8, 2021 · 4 comments
Closed
5 of 11 tasks

[Meta] Core documentation backlog #96592

TinaHeiligers opened this issue Apr 8, 2021 · 4 comments
Labels
documentation Meta Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v8.0.0

Comments

@TinaHeiligers
Copy link
Contributor

TinaHeiligers commented Apr 8, 2021

Documentation is part of development and should be treated with the same importance as good code coverage. This issue is to track documentation-related tech debt for the core-teams' domain.

User-facing guides

User-facing docs (asciidoc system)

New docs system

Relates to Project: Developer Guide v1

  • [newDocs] split logging into overview and tutorials sections
  • [newDocs] split usage_collection into overview and tutorials sections

Dev docs

Plugin Architecture

@botelastic botelastic bot added the needs-team Issues missing a team label label Apr 8, 2021
@mshustov mshustov added the Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc label Apr 8, 2021
@elasticmachine
Copy link
Contributor

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

@botelastic botelastic bot removed the needs-team Issues missing a team label label Apr 8, 2021
@mshustov
Copy link
Contributor

mshustov commented Apr 9, 2021

Enhance core api sections

@TinaHeiligers Could you be more specific about the requirements?

@TinaHeiligers
Copy link
Contributor Author

TinaHeiligers commented Apr 12, 2021

@mshustov I don't have specifics yet, I added that item as a placeholder. Take a look at the docs I've linked to in "Enhance core api sections" and you'll see there's a lot of room for improvement.

@TinaHeiligers
Copy link
Contributor Author

Closing as outdated/stale

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Meta Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v8.0.0
Projects
Status: Done (7.13)
Development

No branches or pull requests

3 participants