The great documentation update #2248
Description
We made great strides in 2.x having our documentation generated from actual code using roslyn to visit certain tests.
This issue serves as an aggregate for remaining documentation issues so we can track it in one issue and make one big last swoop to get it into its final shape.
- Our docs are flattened on elastic.co site. We closely mimic elasticsearch's documentation tree but our generator loses much of this information. We need to be sure the documentation maintains the same tree in the generated asciidoc output.
- We do not generate documentation for the API tests yet. The idea is to visit all
UsageandCrudtests and based on a consistent hash pick one of the 4 ways (sync/async and inititalizer/fluent) (was (Document async options #2239). - similarly all our analysis tests should end up in the documentation (Documentation for Analysis components #1991)
- For various reasons we would like to embedd tables (BenchMarkDotNet output for instance) our AsciiDoc parser does not handle this yet (Support Table elements russcam/asciidocnet#2)
- Revisit the flow of our Core docs (NEST 2.X Documentation Lacks a "Core" Section #2069)
- Documentation: Clarify how a Connection Pool works and that its not responsible for the actual TCP connection pooling (Documentation: Clarify how a Connection Pool works #2260)
- Write a dedicated section on how to see what the client is doing (fiddler, logging, tracing, debuginformation, audits) (Ability to display the query that is being executed in a log message / output window.. #864 Document how to hook Log4Net, NLog, Serilog into NEST/Elasticsearch.NET #865)
- Add Compatibility Matrix from README to docs Add Compatibility Matrix from README to docs #2243
- Document Search Template Document Search Template API usage #2729
- Provide better context in
.doc.cscases see Suggestion: Regarding documentation of Elastic Search #3183 - Document Suggesters (Update suggest-usage.asciidoc #2928)
- Improve Parent/Child documentation (Routing method not available? #3542)
Metadata
Metadata
Assignees
Labels
No labels