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

[DOCS] Documentation for v8 (meta issue) #7624

Open
9 tasks
stevejgordon opened this issue Apr 11, 2023 · 0 comments
Open
9 tasks

[DOCS] Documentation for v8 (meta issue) #7624

stevejgordon opened this issue Apr 11, 2023 · 0 comments

Comments

@stevejgordon
Copy link
Contributor

stevejgordon commented Apr 11, 2023

The current v8 documentation is limited and should be significantly expanded to describe features and patterns around usage. This meta issue tracks the high-level topics and coordinates doc-specific issues to focus on iterative improvements and additions. It is not exhaustive, and items are not listed in priority order. If you identify poorly documented or missing topics, please raise a specific issue where it can be discussed and potentially added to this tracking issue if agreed for inclusion.

Goals:

  • Provide a good developer experience (new users and those migrating from prior versions).
  • Describe patterns rather than attempting to document every endpoint.
  • Provide example code which is fully copy-pastable and includes using directives.
  • Ensure code is imported from test code, which remains current if changes are introduced.

Non-goals:

  • Provide examples for every endpoint, query and aggregation. (Improved code snippets in the Elasticsearch source should cover those).

Documentation topics

  1. 0 of 4
    8.x Area: Documentation
  2. 8.x Area: Documentation Docs
  3. 8.x Area: Documentation
  4. 8.x Area: Documentation
  5. 8.x Area: Documentation Docs
  6. 8.x Area: Documentation
  7. 8.x Area: Documentation Docs
  8. 8.x Area: Documentation
  9. 8.x Area: Documentation
@stevejgordon stevejgordon changed the title [DOCS] Documentation for v8 Meta Issue [DOCS] Documentation for v8 (meta issue) Apr 11, 2023
@elastic elastic locked and limited conversation to collaborators Apr 11, 2023
@stevejgordon stevejgordon pinned this issue Apr 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants