Skip to content

Edit changelog bundle docs#3213

Open
lcawl wants to merge 9 commits intomainfrom
changelog-edits2
Open

Edit changelog bundle docs#3213
lcawl wants to merge 9 commits intomainfrom
changelog-edits2

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Apr 30, 2026

Relates to #3050

This PR cleans up the docs related to the creating bundles.
The goal is for the how-to page (https://elastic.github.io/docs-builder/contribute/bundle-changelogs/) to cover the simplest path (i.e. profiles) and for the reference page (https://elastic.github.io/docs-builder/cli/changelog/bundle/ and others) to cover all the variations and advanced details.

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

coderabbitai Bot commented May 5, 2026

Warning

Rate limit exceeded

@lcawl has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 17 minutes and 6 seconds before requesting another review.

To continue reviewing without waiting, purchase usage credits in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: fccdfb4f-239b-4e2b-84cd-50bda9608c4d

📥 Commits

Reviewing files that changed from the base of the PR and between 62c61f7 and 056eecf.

📒 Files selected for processing (3)
  • config/changelog.example.yml
  • docs/cli/changelog/add.md
  • docs/contribute/bundle-changelogs.md
📝 Walkthrough

Walkthrough

This pull request updates and reorganizes documentation across changelog-related files, primarily focusing on clarifying configuration references and expanding guidance for changelog operations. Changes include: updating documentation links in configuration examples and CLI documentation to reference the new configure-changelogs-ref.md page; adding new CLI option documentation for --hide-features, --input-products, --output-products, --release-version, and --report in the bundle command; expanding the configuration reference with new sections on bundle descriptions and bundle profiles; consolidating removal workflow documentation; and adding guidance sections for changelog rules and GitHub Actions integrations. All changes are documentation-only with no functional code modifications.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Edit changelog bundle docs' is vague and generic, using non-descriptive language that doesn't convey the specific changes made. Use a more descriptive title that highlights the main change, such as 'Reorganize changelog bundle documentation for clarity' or 'Refactor bundle docs: simplify how-to, expand reference pages.'
✅ Passed checks (4 passed)
Check name Status Explanation
Description check ✅ Passed The description clearly relates to the changeset, explaining the restructuring of documentation to separate simple paths from advanced details.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ 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-edits2

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@config/changelog.example.yml`:
- Line 154: The documentation URL in the comment contains a duplicate path
segment ("contribute/contribute/configure-changelogs-ref"); update the URL
string to use the correct path "contribute/configure-changelogs-ref.md" so the
link points to the intended reference (replace the existing URL in the comment
that currently reads
"https://github.com/elastic/docs-builder/blob/main/docs/contribute/contribute/configure-changelogs-ref"
with
"https://github.com/elastic/docs-builder/blob/main/docs/contribute/configure-changelogs-ref.md").

In `@docs/contribute/bundle-changelogs.md`:
- Line 430: Replace the typo "visibiblity" with the correct spelling
"visibility" in the sentence that reads "If you are working in a private repo
and do not want any pull request or issue links to appear (even if they target a
public repo), you can also configure link visibiblity in the [changelog
directive](/syntax/changelog.md#hide-links) and [changelog
render](/cli/changelog/render.md) command." by editing that exact phrase ("link
visibiblity") to "link visibility" so the references to [changelog directive]
and [changelog render] remain unchanged.
🪄 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: Enterprise

Run ID: 87656266-9ca6-4148-a2f8-c3e2620f167c

📥 Commits

Reviewing files that changed from the base of the PR and between b31505c and 62c61f7.

📒 Files selected for processing (10)
  • config/changelog.example.yml
  • docs/cli/changelog/add.md
  • docs/cli/changelog/bundle.md
  • docs/cli/changelog/gh-release.md
  • docs/cli/changelog/remove.md
  • docs/contribute/bundle-changelogs.md
  • docs/contribute/configure-changelogs-ref.md
  • docs/contribute/configure-changelogs.md
  • docs/contribute/create-changelogs.md
  • docs/syntax/changelog.md

Comment thread config/changelog.example.yml Outdated
Comment thread docs/contribute/bundle-changelogs.md Outdated
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