Skip to content

[DOCS] Split changelog how-to into subpages#3096

Open
lcawl wants to merge 2 commits intomainfrom
changelog-contrib
Open

[DOCS] Split changelog how-to into subpages#3096
lcawl wants to merge 2 commits intomainfrom
changelog-contrib

Conversation

@lcawl
Copy link
Copy Markdown
Member

@lcawl lcawl commented Apr 13, 2026

This PR is the first step in #3050.
It splits https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/changelog into subpages so it's not so overwhelming. Each subpage will be edited in subsequent PRs.

@lcawl lcawl added the documentation Improvements or additions to documentation label Apr 13, 2026
@lcawl lcawl mentioned this pull request Apr 13, 2026
5 tasks
@lcawl lcawl marked this pull request as ready for review April 13, 2026 23:35
@lcawl lcawl requested review from a team as code owners April 13, 2026 23:35
@lcawl lcawl requested review from cotti and reakaleek April 13, 2026 23:35
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 13, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 85a7e282-5b83-4c32-a138-503ba0a204d4

📥 Commits

Reviewing files that changed from the base of the PR and between bb0ed07 and 71d4902.

📒 Files selected for processing (1)
  • src/services/Elastic.Changelog/Configuration/ChangelogConfigurationLoader.cs
✅ Files skipped from review due to trivial changes (1)
  • src/services/Elastic.Changelog/Configuration/ChangelogConfigurationLoader.cs

📝 Walkthrough

Walkthrough

This PR restructures changelog documentation into focused pages: adds docs/contribute/{configure-changelogs.md,create-changelogs.md,bundle-changelogs.md,publish-changelogs.md}, trims docs/contribute/changelog.md to an overview, and updates docs/_docset.yml TOC to nest these pages. CLI and syntax docs update cross-references to the new pages. docs/cli changelog guides and changelog.example.yml comments receive link and guidance adjustments. Two C# diagnostics (in ChangelogBundlingService.cs and ChangelogConfigurationLoader.cs) update their documentation URLs to the new GitHub docs-builder locations. No functional code changes.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: splitting a large changelog documentation page into focused subpages.
Description check ✅ Passed The description clearly references issue #3050 and explains the purpose: splitting the changelog how-to into subpages for clarity.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch changelog-contrib

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In
`@src/services/Elastic.Changelog/Configuration/ChangelogConfigurationLoader.cs`:
- Line 871: Replace the inconsistent docs URL string in
ChangelogConfigurationLoader (the line that currently references
"https://elastic.github.io/docs-builder/contribute/configure-changelogs/#bundle-rule-modes")
with the repository-style URL used elsewhere in this file—use
"https://github.com/elastic/docs-builder/blob/main/docs/contribute/configure-changelogs.md#bundle-rule-modes"
so it matches the other updated links (look for the surrounding code in
ChangelogConfigurationLoader where similar docs links appear around lines 805
and 820).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: ed84b162-d3fb-4bb9-9018-649d77ca153c

📥 Commits

Reviewing files that changed from the base of the PR and between 7d776e3 and bb0ed07.

📒 Files selected for processing (16)
  • config/changelog.example.yml
  • docs/_docset.yml
  • docs/cli/changelog/add.md
  • docs/cli/changelog/bundle-amend.md
  • docs/cli/changelog/bundle.md
  • docs/cli/changelog/gh-release.md
  • docs/cli/changelog/remove.md
  • docs/cli/changelog/render.md
  • docs/contribute/bundle-changelogs.md
  • docs/contribute/changelog.md
  • docs/contribute/configure-changelogs.md
  • docs/contribute/create-changelogs.md
  • docs/contribute/publish-changelogs.md
  • docs/syntax/changelog.md
  • src/services/Elastic.Changelog/Bundling/ChangelogBundlingService.cs
  • src/services/Elastic.Changelog/Configuration/ChangelogConfigurationLoader.cs

…ationLoader.cs

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant