Skip to content

Remove how-to pages from data/release-notes (moved to release-notes-automation docs) - #4236

Merged
Mpdreamz merged 24 commits into
mainfrom
docs/remove-changelog-section
Nov 5, 2026
Merged

Mpdreamz merged 24 commits into
mainfrom
docs/remove-changelog-section

Conversation

@theletterf

@theletterf theletterf commented Sep 29, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Deletes create.md, configure.md, publish.md, overview.md, explorer.md, and _snippets/ from data/release-notes/. Setup and integration content moves to the Release Notes Automation docset.
  • Replaces index.md with a minimal landing page linking to the external docs and to the two CLI-centric pages that stay here.
  • Updates _docset.yml toc to the three remaining files (index.md, bundle.md, configure-ref.md).
  • Fixes all broken cross-references in cli/changelog/ and development/.
  • Adds _redirects.yml entries for all deleted pages and corrects the existing contribute/* chain.

Test plan

  • Verify docs-builder serve shows the trimmed data/release-notes/ section with only the landing page, Bundle changelogs, and Configuration reference.
  • Confirm all redirected URLs (e.g. /data/release-notes/overview, /contribute/changelog) resolve to the new targets.
  • Check that cross-links from CLI reference pages still render (no broken link warnings).

🤖 Generated with Claude Code

Related to #4339

theletterf and others added 17 commits August 14, 2026 16:25
The navigation model may intentionally preserve identical sidebar trees across htmx navigations, so the synthetic should assert the visible target group and only require a fresh DOM node when the tree id changes.

Co-Authored-By: GPT-5.5 <noreply@openai.com>
The "Learn more about agent skills" link was built from `UrlPathPrefix`,
which is repo-specific. In cross-repo setups the link resolved to a path
under the wrong repo prefix and produced a 404. The link now points to
the canonical `elastic.co/docs` URL regardless of which repo renders it.

Co-Authored-By: Claude <noreply@anthropic.com>
…s-automation docs

Full setup and integration guides are moving to the release-notes-automation docset.
Keeps only bundle.md and configure-ref.md (CLI-centric content that belongs here).

- Delete create.md, configure.md, publish.md, overview.md, explorer.md, _snippets/
- Replace index.md with a minimal landing page linking out to the external docs
- Update _docset.yml toc to the three remaining files
- Fix all cross-references in cli/changelog/* and development/ to point to index.md
- Add _redirects.yml entries for all deleted pages and fix broken contribute/* chain

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Requesting changes for one additional blocking issue that could not be left inline because the affected file was deleted in this diff:

  • [HIGH] Missing include target after snippet deletion: docs/documentation/catalog/versions.md still includes /data/release-notes/_snippets/tag-processing.md (line 16), but this PR removes docs/data/release-notes/_snippets/tag-processing.md. That leaves a broken include path and can fail docs parsing/build. Please either keep/move that snippet and update the include path, or inline/replace the included content in versions.md.

What is this? | From workflow: PR Review

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

Comment thread docs/_redirects.yml Resolved
theletterf and others added 2 commits September 29, 2026 14:57
The snippet was previously in data/release-notes/_snippets/ which is
removed in this branch. versions.md in the catalog section was the only
consumer; move the snippet alongside it.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
bundle.md and syntax/changelog.md still linked to deleted pages
(overview.md, configure.md, create.md, publish.md). Update all
references to point to the surviving pages (index.md, configure-ref.md).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@theletterf theletterf added the documentation Improvements or additions to documentation label Sep 29, 2026

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

APPROVE


What is this? | From workflow: PR Review

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

hub-whats-new.yml linked to overview.md via a hub URL directive.
configure-ref.md linked to create.md#rules. Both pages were removed
in this branch; update links to the surviving index.md.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Remove configure.md, create.md, overview.md, publish.md from the
links section; add index.md. Update contribute/* redirect targets
and add data/release-notes/* redirect entries to match _redirects.yml.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
configure.md and create.md are deleted on this branch and were edited on
main (pivot.required notes in configure.md, impact and action notes in
create.md). Kept the deletion: this branch moves that guidance to the
Release Notes Automation docs. The options main documented are still
described in the pages that remain, configure-ref.md (pivot.required)
and cli/changelog/cmd-evaluate-pr.md (--require-impact-action).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Comment thread docs/_redirects.yml
Comment on lines +82 to +84
'data/release-notes/configure.md': 'data/release-notes/configure-ref.md'
'data/release-notes/create.md': 'data/release-notes/index.md'
'data/release-notes/publish.md': 'data/release-notes/index.md'

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Severity: P3 (Low)

The data/release-notes/configure.md redirect preserves legacy section fragments, so URLs such as configure.md#authorization now land at configure-ref.md#authorization, which has no matching section. Map or strip this obsolete fragment so the legacy link does not point to a nonexistent section.

Generated by Libra. React with 👍 or 👎 to give feedback on this comment.

@Mpdreamz
Mpdreamz merged commit ada9817 into main Nov 5, 2026
37 checks passed
@Mpdreamz
Mpdreamz deleted the docs/remove-changelog-section branch November 5, 2026 08:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog:skip documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants