docs: rework data views intro and split into a section (#7502) - #7723
Draft
florent-leborgne wants to merge 4 commits into
Draft
docs: rework data views intro and split into a section (#7502)#7723florent-leborgne wants to merge 4 commits into
florent-leborgne wants to merge 4 commits into
Conversation
Splits the single data-views.md page into an overview plus 9 child pages by content type (how-to, reference), and reworks the intro to explain the three ways a data view comes to exist: created for you, created by you, and managed by Elastic. De-duplicates the managed data view explanation, which was previously repeated in three places, into one authoritative location on the overview page.
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
docs-builder doesn't register custom [id] anchors on a page's H1 heading for cross-file linking, only on H2+. The split moved several sub-headings to become new pages' H1s, breaking links that used their old anchor fragment. Drop those fragments (the whole target page is now the content) and restore an H2-level anchor on the overview page for the one cross-repo (Kibana) backlink to the old CCS/CPS/rollup section, which a docs-content-only search couldn't have surfaced.
Contributor
Contributor
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
The String-transformations list and the Url field formatter explanation were each repeated verbatim 3-4 times across the String, Date, Geographic point, and Number sections (already flagged during review as worth consolidating). Move each into a single shared subsection that the per-type sections link to. This also resolves the Elastic.Spelling flags on the page, which only fire with docs-content's Elastic.Spelling override enabled (not on by default upstream) and were a symptom of the duplication rather than a wording problem.
Both lines already changed in this branch to strip a broken anchor fragment; clean up the pre-existing 'just' and 'may' Vale flags that shared those same lines while we're here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses #7502, and goes beyond its literal scope: while reviewing the page for content-type alignment (part of the issue's ask), it became clear the single 700+ line page mixed overview, how-to, and heavy reference content. Rather than a light touch-up, this splits Data views into a proper section: one overview page plus 9 child pages by content type, following the same pattern already used for Dashboards and Cases.
explore-analyze/find-and-organize/data-views.md: Rewritten as a short overview. Adds the three-paths mental model the issue asked for (created for you / created by you / managed by Elastic), including that "created for you" and "managed" are not the same set (only Fleet-installed data views are both). This is now the single authoritative explanation of what a managed data view is — every other page that used to restate it (there were three copies, not the two the issue described) links back here instead.data-views/create-data-view.md(new, how-to): the creation steps and the temporary/ad-hoc data view path, with a proper Before you begin, success checkpoint, and Related pages.data-views/data-view-search-syntax.md(new, reference): cross-cluster search, cross-project search, and rollup index syntax, split out of the creation how-to since it's reference material, not sequential steps.data-views/delete-data-view.md(new, how-to): the delete workflow, with the managed-data-view restriction trimmed to a one-line cross-reference.data-views/duplicate-data-view.md(new, how-to): reframed from "Duplicate managed data views" to a general duplicate-a-data-view guide — duplication isn't managed-only in the product (confirmed against the Kibana source: the duplicate action is wired for any data view), with the managed read-only restriction named as one strong reason among others.data-views/customize-data-view-fields.md(new, overview hub): short grouping page linking to the four field-customization pages below.data-views/runtime-fields.md,data-views/scripted-fields.md,data-views/field-formatters.md,data-views/data-view-field-cache.md(new): direct moves of the corresponding existing content, each with its own frontmatter, and (for the how-to pages) Before you begin / success checkpoint sections added.explore-analyze/toc.yml: adds the new nested navigation under Data views.docs-content: internal links that pointed at anchors now living on a child page (for exampledata-views.md#runtime-fields) are updated to point at the new file directly, since anchor fragments aren't redirected. Whole-page links todata-views.md(the large majority) are untouched and continue to work.Verification
docs-content-type-checkeragainst all 10 new/rewritten pages; fixed the gaps it found (missing Before you begin / success checkpoint on 3 pages, a title/content mismatch on the scripted fields page now that field creation was removed in 9.0).Resolves
Closes #7502