[DOCS] Group rollup and transform content #46882
Conversation
lcawl
added
>docs
|
Pinging @elastic/es-analytics-geo |
|
Pinging @elastic/es-docs |
lcawl
requested review from
colings86,
debadair,
jrodewig,
polyfractal and
sophiec20
debadair
left a comment
debadair
left a comment
There was a problem hiding this comment.
Left a few comments. The important one is that I think the anchor should be tweaked.
| @@ -0,0 +1,16 @@ | |||
| [[data-operations]] | |||
| = Roll up or transform your data | |||
There was a problem hiding this comment.
Since this is the name of the top-level page, I think it would be better to be more verbose for SEO purposes. Maybe [data-rollup-transform]?
| include::frozen-indices.asciidoc[] | ||
|
|
||
| include::data-operations.asciidoc[] | ||
|
|
There was a problem hiding this comment.
I'd match the revised anchor-text.
| [[rollup-api-jobs]] | ||
| === /job/ | ||
| ==== /job/ | ||
|
|
There was a problem hiding this comment.
Are the slashes consistent with other APIs?
| [[rollup-overview]] | ||
| == Overview | ||
| === {rollup-cap} overview | ||
| ++++ |
There was a problem hiding this comment.
Structurally, I think it would be better if we could incorporate the "overview" material into the top level section landing pages, instead of just making them link farms. Or make the top-level headings just landmarks and not actually navigable links in the TOC (as @gchaps suggested). Then this content would have the "overview" keyword for SEO, but we'd get rid of the extra click to get to meaningful content.) For now, this is consistent with other topics.
There was a problem hiding this comment.
I agree that this will be worth discussing in more detail as we roll out the reorg and strive for consistency, but for now I'll leave as-is.
| [float] | ||
| === Rollup store historical data at reduced granularity | ||
| ==== Rollup store historical data at reduced granularity | ||
|
|
There was a problem hiding this comment.
"Rollup store historical data" is clunky. Rollup stores? Roll up to store? Or maybe "Storing historical data at reduced granularity"? (The pattern here of repeating Rollup in every heading kind seems like overkill.)
There was a problem hiding this comment.
I've updated it to match the other sections, but I agree this page could do with an edit. Will defer and just stick to structural changes here, however.
| [[rollup-getting-started]] | ||
| == Getting Started | ||
| === Getting started with {rollups} | ||
| ++++ |
There was a problem hiding this comment.
Ultimately, I think this is an example of a place we don't want to use the "Getting started" terminology.
7 participants
This PR creates a new top-level section that will contain documentation for the rollup and transform features.
Related to #46718
The addition of transform (and perhaps reindexing) information to this section will occur in subsequent PRs.
Preview: http://elasticsearch_46882.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/data-rollup-transform.html