Skip to content

Draft: Restructure Streams docs#6665

Draft
alaudazzi wants to merge 15 commits into
mainfrom
alaudazzi/streams-page-restructure
Draft

Draft: Restructure Streams docs#6665
alaudazzi wants to merge 15 commits into
mainfrom
alaudazzi/streams-page-restructure

Conversation

@alaudazzi
Copy link
Copy Markdown
Member

@alaudazzi alaudazzi commented May 22, 2026

===== PLEASE DO NOT REVIEW =====

Summary

Restructures solutions/observability/streams/streams.md around a user-first narrative.

The current pages jump straight into implementation details without explaining what Streams is, why someone should care, or how to get started. We want to reorganize the content around user needs.


This is an example of how the landing page could be reworked:
image


And this is an example of how the new Getting started could look:
image

@mdbirnstiehl This high-level flow originates from the various docs I've been going through. It needs to be tested.

Reorganizes streams.md to lead with what Streams is, why to use it
(Organize logs / Get meaning from logs / Find problems in logs),
prerequisites, real-life use cases, and recommended paths for novice
and expert users. All original reference sections are preserved.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@alaudazzi alaudazzi self-assigned this May 22, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 22, 2026

🔍 Preview links for changed docs

@github-actions
Copy link
Copy Markdown
Contributor

Vale Linting Results

Summary: 1 warning found

⚠️ Warnings (1)
File Line Rule Message
solutions/observability/streams/streams.md 44 Elastic.Spelling 'expirations' is a possible misspelling.

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.

@alaudazzi alaudazzi changed the title Draft: Restructure Streams overview page Draft: Restructure Streams docs May 24, 2026
@alaudazzi
Copy link
Copy Markdown
Member Author

@copilot resolve the merge conflicts in this pull request

Co-authored-by: alaudazzi <46651782+alaudazzi@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI commented May 24, 2026

@copilot resolve the merge conflicts in this pull request

Resolved the merge conflict and merged origin/main into this branch in commit 34ab4a1. The conflicted solutions/observability/streams/streams.md path was resolved by keeping the branch’s deletion (consistent with the Streams page restructure).

@alaudazzi
Copy link
Copy Markdown
Member Author

@copilot fix the CI checks

Copy link
Copy Markdown
Contributor

Copilot AI commented May 24, 2026

@copilot fix the CI checks

Fixed the CI-breaking docs links in 779b81f by updating all stale wired-streams.md and streams.md#... references to classic-wired-streams.md anchors. The previous docs-build failure root cause is addressed; the latest docs-build run is currently action_required (no jobs started yet).

@alaudazzi
Copy link
Copy Markdown
Member Author

@copilot fix the CI checks

Copy link
Copy Markdown
Contributor

Copilot AI commented May 25, 2026

@copilot fix the CI checks

Fixed the current docs-build error in f2a29f9 by updating the broken anchor in manual-pipeline-configuration.md to #streams-classic-streams. The latest docs-build run for this commit is now action_required (no jobs executed yet), so it needs workflow approval/re-run to complete the checks.

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.

2 participants