-
Notifications
You must be signed in to change notification settings - Fork 24.9k
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
Update and edit logsdb docs for logsdb / synthetic source GA #118303
Conversation
Documentation preview: |
Pinging @elastic/es-docs (Team:Docs) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes look good to me. How we call out subscription requirements is the biggest factual question for me.
Otherwise, my main qualm with this page is the structure/headings. Here's a potential heading structure that tries to regroup info, and might make the page easier to scan in the TOC:
Overview
Basic setup
Storage optimization
- Synthetic source
- Fields without doc values
- Specialized codecs
Sort settings
- Index sort defaults
- Sort orders and modes
Data validation defaults
- ignore_malformed
- ignore_above
- ignore_dynamic_beyond_limit
Full settings reference
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Thanks, agreed. Not sure I can tackle this now but will make it a "fast-follow" if not |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
some nits and questions for you! love the edits - it reads much clearer now
Co-authored-by: shainaraskas <[email protected]>
Co-authored-by: shainaraskas <[email protected]>
Co-authored-by: Oleksandr Kolomiiets <[email protected]>
Co-authored-by: Oleksandr Kolomiiets <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logsdb changes lgtm!
are the tsdb "grandfathered" nuances covered anywhere? wondering how people who have old tsdb data streams should expect new ones to behave, or should account for differences between elasticsearch instances.
…#118303) * Update licensing; fix screenshots; edit generally * Small edit for clarity and style * Update docs/reference/index-modules.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Apply changes from review Co-authored-by: Liam Thompson <[email protected]> * Address review comments * Match similar change from review * More changes from review * Apply suggestions from review Co-authored-by: shainaraskas <[email protected]> * Apply suggestions from review Co-authored-by: shainaraskas <[email protected]> * Update docs/reference/data-streams/logs.asciidoc Co-authored-by: shainaraskas <[email protected]> * Apply suggestions from review Co-authored-by: shainaraskas <[email protected]> * Apply suggestions from review * Change to general subscription note * Apply suggestions from review Co-authored-by: Oleksandr Kolomiiets <[email protected]> * Apply suggestions from review Co-authored-by: Oleksandr Kolomiiets <[email protected]> * Apply suggestions from review; additional edits * Apply suggestions from review; clarity tweaks * Restore previous paragraph structure and context --------- Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: shainaraskas <[email protected]> Co-authored-by: Oleksandr Kolomiiets <[email protected]> (cherry picked from commit ae9bb90)
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
…#118303) * Update licensing; fix screenshots; edit generally * Small edit for clarity and style * Update docs/reference/index-modules.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Apply changes from review Co-authored-by: Liam Thompson <[email protected]> * Address review comments * Match similar change from review * More changes from review * Apply suggestions from review Co-authored-by: shainaraskas <[email protected]> * Apply suggestions from review Co-authored-by: shainaraskas <[email protected]> * Update docs/reference/data-streams/logs.asciidoc Co-authored-by: shainaraskas <[email protected]> * Apply suggestions from review Co-authored-by: shainaraskas <[email protected]> * Apply suggestions from review * Change to general subscription note * Apply suggestions from review Co-authored-by: Oleksandr Kolomiiets <[email protected]> * Apply suggestions from review Co-authored-by: Oleksandr Kolomiiets <[email protected]> * Apply suggestions from review; additional edits * Apply suggestions from review; clarity tweaks * Restore previous paragraph structure and context --------- Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: shainaraskas <[email protected]> Co-authored-by: Oleksandr Kolomiiets <[email protected]> (cherry picked from commit ae9bb90)
#118504) * Update licensing; fix screenshots; edit generally * Small edit for clarity and style * Update docs/reference/index-modules.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Apply changes from review Co-authored-by: Liam Thompson <[email protected]> * Address review comments * Match similar change from review * More changes from review * Apply suggestions from review Co-authored-by: shainaraskas <[email protected]> * Apply suggestions from review Co-authored-by: shainaraskas <[email protected]> * Update docs/reference/data-streams/logs.asciidoc Co-authored-by: shainaraskas <[email protected]> * Apply suggestions from review Co-authored-by: shainaraskas <[email protected]> * Apply suggestions from review * Change to general subscription note * Apply suggestions from review Co-authored-by: Oleksandr Kolomiiets <[email protected]> * Apply suggestions from review Co-authored-by: Oleksandr Kolomiiets <[email protected]> * Apply suggestions from review; additional edits * Apply suggestions from review; clarity tweaks * Restore previous paragraph structure and context --------- Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: shainaraskas <[email protected]> Co-authored-by: Oleksandr Kolomiiets <[email protected]> (cherry picked from commit ae9bb90) Co-authored-by: Marci W <[email protected]>
#118505) * Update licensing; fix screenshots; edit generally * Small edit for clarity and style * Update docs/reference/index-modules.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Apply changes from review Co-authored-by: Liam Thompson <[email protected]> * Address review comments * Match similar change from review * More changes from review * Apply suggestions from review Co-authored-by: shainaraskas <[email protected]> * Apply suggestions from review Co-authored-by: shainaraskas <[email protected]> * Update docs/reference/data-streams/logs.asciidoc Co-authored-by: shainaraskas <[email protected]> * Apply suggestions from review Co-authored-by: shainaraskas <[email protected]> * Apply suggestions from review * Change to general subscription note * Apply suggestions from review Co-authored-by: Oleksandr Kolomiiets <[email protected]> * Apply suggestions from review Co-authored-by: Oleksandr Kolomiiets <[email protected]> * Apply suggestions from review; additional edits * Apply suggestions from review; clarity tweaks * Restore previous paragraph structure and context --------- Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: shainaraskas <[email protected]> Co-authored-by: Oleksandr Kolomiiets <[email protected]> (cherry picked from commit ae9bb90) Co-authored-by: Marci W <[email protected]>
Hi @marciw thanks for all the changes. I'll try to do a full review very soon. I did already notice one thing: In https://elasticsearch_bk_118303.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/index-modules.html#_static_index_settings it lists "tsds" as a valid index mode. AFAIK this is not valid and should be time_series. TSDS is the common abbreviation for that but is not an actual setting value for ES. |
oof, I think that's been there for a long time -- good catch. Fixed in #118579 |
This update focuses on licensing and core functionality for the GA release. All suggestions welcome; some will be moved to new issues (coming soon) for fast-follow or 9.0 improvements.
Updated previews
Includes a general editing pass on changes made in #115205 (which didn't get a docs team review) 😿
Closes https://github.com/elastic/search-docs-team/issues/193
Note: I compared the docs to the in-progress blog post and didn't see any gaps, but I'll keep checking the blog post and will link to it from the docs when it's ready.