Skip to content

Retitle the Fleet data retention tutorials with task-based titles - #7853

Merged
vishaangelova merged 7 commits into
mainfrom
7852-retitle-data-retention-tutorials
Aug 19, 2026
Merged

Retitle the Fleet data retention tutorials with task-based titles#7853
vishaangelova merged 7 commits into
mainfrom
7852-retitle-data-retention-tutorials

Conversation

@vishaangelova

@vishaangelova vishaangelova commented Aug 7, 2026

Copy link
Copy Markdown
Member

Summary

The four ILM tutorials under Data streams were titled and navigated as Scenario 1Scenario 4, which left the left nav showing nothing but the numbers. The numbers don't encode a sequence — the pages are alternatives, and every cross-reference between them treats them as such — so the label was one the reader couldn't decode without going back to the hub. This PR gives each page a verb-first H1 that states the outcome and a short nav title that differentiates at a glance, and drops the content-type prefix from the two tutorial titles in the same section.

No URLs, filenames, or heading anchors change, so no redirects are needed.

Resolves #7852

Changes

  • Scenario pages: New H1s and navigation_title values for data-streams-scenario1.md through data-streams-scenario4.md. The nav labels drop the verb because the parent entry already supplies it, and repeating "Apply an ILM policy to" four times would push the distinguishing words to the right of every label. Scenario 3's H1 also now states its outcome (one data stream in one namespace) rather than its setup.
  • reference/fleet/data-streams-ilm-tutorial.md: Drops the Tutorials: prefix from the H1, renames the Identify your scenario heading, and rewrites the list so each entry leads with the page's task and follows with the mechanism it uses, which is what makes the options easy to tell apart. The namespace ILM option stays a note under the list, as on main.
  • reference/fleet/data-streams-pipeline-tutorial.md: Drops the Tutorial: prefix from the H1.
  • reference/fleet/data-streams-namespace-ilm.md: Replaces the in-prose Scenario 2 and Scenario 3 links, and drops the Tutorials: prefix from the related-pages link.
  • Cross-links: Replaces the seven in-prose Scenario N references with descriptive link text, and normalizes inbound link text for both tutorial pages, which had drifted into four variants across the docset.

Nav before and after

Data streams/                                    Data streams/
└── Tutorials: Customize data retention          └── Customize data retention policies/
    policies/                                        ├── All data streams, all namespaces
    ├── Scenario 1                        →          ├── Specific data streams, all namespaces
    ├── Scenario 2                                   ├── One data stream, one namespace
    ├── Scenario 3                                   └── Custom integrations
    └── Scenario 4

Notes for review

  • Rebased onto main after Document assigning an ILM policy to an integration namespace #7808 merged. The hub list keeps that PR's note for the namespace ILM page; the four scenario bullets above it are retitled.
  • Ordinary in-body uses of "scenario" ("In this scenario, you have {{agent}}s collecting…") are deliberately left alone. They read as plain English and are used consistently across these tutorials, including the ingest pipeline one.
  • The published URLs still contain scenario1scenario4. Renaming the files would pull in redirects for every page plus the legacy mapped_pages entries, so that's left out of scope.

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).

Tool(s) and model(s) used: Cursor / Claude Opus 5; rebase and description update with Cursor / Grok 4.6

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check 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.

Base automatically changed from 7701-fleet-namespace-ilm-policy to main August 7, 2026 13:00
Co-authored-by: Cursor <cursoragent@cursor.com>
@vishaangelova
vishaangelova force-pushed the 7852-retitle-data-retention-tutorials branch from aac6822 to b05cc10 Compare August 18, 2026 13:34
@vishaangelova
vishaangelova marked this pull request as ready for review August 18, 2026 13:40
@vishaangelova
vishaangelova requested a review from a team as a code owner August 18, 2026 13:40
@github-actions

Copy link
Copy Markdown
Contributor

Docs review summary

Focus areas

  • Style and clarity: No new issues in the changed lines. All retitled H1s, navigation_title values, and updated cross-reference link text stay consistent with each other (hub list bullets match each scenario page's H1, and every cross-link now uses descriptive text instead of "Scenario N").
  • Jargon: None introduced by this diff.
  • Frontmatter and applies_to: navigation_title changes are the only frontmatter edits; values are concise and differentiate the four scenario pages as intended. No applies_to changes in scope.
  • Content type fit: Not affected — only titles/nav labels/link text changed, not page structure.
  • Contradictions: No contradictions found.
  • Parent issue satisfaction: Satisfied. Retitle the Fleet data retention tutorials: drop the "Scenario N" and "Tutorial" prefixes #7852 asked for nav labels that don't decode as bare numbers; the PR gives each scenario page a distinct, outcome-based navigation_title and aligns every H1 and cross-link with it.

Nits

  • reference/fleet/integrations-assets-best-practices.md line 89 (a line this PR edits to update the scenario links) still ends with "...to avoid the problems mentioned above," which Vale flags as directional language (Elastic.DirectionalLanguage). Since the line is already being touched, replacing "mentioned above" with something like "described earlier on this page" would clear it while you're in there.

Notes

  • Vale's other findings in these files (MenuArrows, Clone, MappedPages) fall on lines this PR doesn't touch, so they're left out of scope per pre-existing-issue rules.

Generated by Docs review agent for #7853 · sonnet50 · 33.3 AIC · ⌖ 3.85 AIC · ⊞ 17.6K ·

Comment thread reference/fleet/integrations-assets-best-practices.md Outdated
@github-actions

github-actions Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs Style Checker (Vale)

Summary: 3 suggestions found

💡 Suggestions (3): Optional style improvements. Apply when helpful.
File Line Rule Message
manage-data/ingest/transform-enrich/ingest-pipelines.md 254 Elastic.Repetition "to" is repeated.
manage-data/lifecycle/index-lifecycle-management/manage-lifecycle-integrations-data.md 67 Elastic.Repetition "in" is repeated.
reference/fleet/data-streams.md 274 Elastic.Repetition "to" is repeated.

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.

@jillguyonnet jillguyonnet left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very helpful rewrite, thanks! 🚀

Comment thread reference/fleet/data-streams-ilm-tutorial.md Outdated
Keep the shorter label as the nav title so the left nav under Data streams stays scannable.

Co-authored-by: Cursor <cursoragent@cursor.com>
@vishaangelova
vishaangelova requested a review from a team as a code owner August 18, 2026 14:39
Comment thread reference/fleet/data-streams-ilm-tutorial.md Outdated
Comment thread reference/fleet/data-streams-ilm-tutorial.md Outdated
Comment thread reference/fleet/integrations-assets-best-practices.md Outdated

@bmorelli25 bmorelli25 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we update this line too:

These tutorials go into greater depth about creating and using `@custom` component templates. For example, the tutorial [Apply an ILM policy to all data streams generated from {{fleet}} integrations across all namespaces](/reference/fleet/data-streams-scenario1.md) shows how to create and use the `logs@custom` and `metrics@custom` component templates to customize {{ilm-init}} policies associated with data streams in integrations.

And a couple more suggestions. TY! 🐻‍❄️

@shainaraskas shainaraskas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the file owned by my team lgtm, with one unrequested suggestion to make this evergreen

vishaangelova and others added 3 commits August 19, 2026 09:48
Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: Visha Angelova <91186315+vishaangelova@users.noreply.github.com>
@vishaangelova
vishaangelova force-pushed the 7852-retitle-data-retention-tutorials branch from cde8c26 to df56d5c Compare August 19, 2026 08:11
@vishaangelova
vishaangelova merged commit 84f973b into main Aug 19, 2026
8 checks passed
@vishaangelova
vishaangelova deleted the 7852-retitle-data-retention-tutorials branch August 19, 2026 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Retitle the Fleet data retention tutorials: drop the "Scenario N" and "Tutorial" prefixes

4 participants