Skip to content

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

Open
@stevejgordon

Description

@stevejgordon

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
- [ ] https://github.com/elastic/elasticsearch-net/issues/7538
- [ ] https://github.com/elastic/elasticsearch-net/issues/7626
- [ ] https://github.com/elastic/elasticsearch-net/issues/7625
- [ ] https://github.com/elastic/elasticsearch-net/issues/7627
- [ ] https://github.com/elastic/elasticsearch-net/issues/7628
- [ ] https://github.com/elastic/elasticsearch-net/issues/7629
- [ ] https://github.com/elastic/elasticsearch-net/issues/7630
- [ ] https://github.com/elastic/elasticsearch-net/issues/7649
- [ ] https://github.com/elastic/elasticsearch-net/issues/7651

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions