⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 14, 2026

Summary

This PR is a test of the docs-builder changelog add and docs-builder changelog bundle commands.

In particular, it contains output files generated via elastic/docs-builder#2350 and elastic/docs-builder#2461

The changelog and bundle files that create this content are collected from:

NOTE:

No edits were performed on any of the generated changelogs, so they just contain whatever titles, areas, and types could be pulled from the PRs. This PR contains two variations of the output, one with and one without "subsections" (area categorizations).

The command to generate this content is:

./docs-builder changelog render \
--config /path/to/docs-content/release-notes/elastic-cloud-serverless/elastic-cloud-serverless-changelog.yml \
--input "/path/to/elasticsearch-serverless/docs/changelog/bundles/cloud-serverless-2025-01-13.yaml|/path/to/elasticsearch-serverless/docs/changelog/2025-01-13|elasticsearch-serverless|hide-links,/path/to/elasticsearch/docs/release-notes/changelog-bundles/cloud-serverless-2025-01-13.yaml|/path/to/elasticsearch/docs/changelog/2025-01-13|elasticsearch|keep-links,/path/to/kibana/docs/changelog/bundles/cloud-serverless-2025-01-13.yaml|/path/to/kibana/docs/changelog/2025-01-13|kibana|keep-links" \
--output /path/to/docs-content/release-notes/elastic-cloud-serverless/_snippets/

Screenshots

Without --subsections option, the output looks like this:

image

With the --subsections option, the output looks like this:

image

The PRs that are listed outside an area section are changelogs that didn't contain that info (i.e. areas could not be derived from PR labels).

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

@github-actions
Copy link
Contributor

Vale Linting Results

Summary: 2 warnings, 8 suggestions found

⚠️ Warnings (2)
File Line Rule Message
release-notes/elastic-cloud-serverless/_snippets/2025-01-13.1/index.md 89 Elastic.QuotesPunctuation Put punctuation outside the quotation marks.
release-notes/elastic-cloud-serverless/_snippets/2025-01-13.2/index.md 55 Elastic.QuotesPunctuation Put punctuation outside the quotation marks.
💡 Suggestions (8)
File Line Rule Message
release-notes/elastic-cloud-serverless/_snippets/2025-01-13.1/index.md 64 Elastic.FutureTense 'won't show' might be in future tense. Write in the present tense to describe the state of the product as it is now.
release-notes/elastic-cloud-serverless/_snippets/2025-01-13.1/index.md 79 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI.
release-notes/elastic-cloud-serverless/_snippets/2025-01-13.1/index.md 95 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI.
release-notes/elastic-cloud-serverless/_snippets/2025-01-13.1/index.md 111 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI.
release-notes/elastic-cloud-serverless/_snippets/2025-01-13.2/index.md 40 Elastic.FutureTense 'won't show' might be in future tense. Write in the present tense to describe the state of the product as it is now.
release-notes/elastic-cloud-serverless/_snippets/2025-01-13.2/index.md 49 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI.
release-notes/elastic-cloud-serverless/_snippets/2025-01-13.2/index.md 59 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI.
release-notes/elastic-cloud-serverless/_snippets/2025-01-13.2/index.md 69 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI.

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.

@github-actions
Copy link
Contributor

🔍 Preview links for changed docs

@benironside
Copy link
Contributor

I like this, especially the version with the feature sub-headings. Interesting to see a changelog that hasn't had the "personal touch" of a writer going through the PRs and updating their descriptions. @lcawl are you envisioning that we can move away from relying on that manual work for changelogs and shift more responsibility to the folks writing the PR descriptions as we move towards using this new tool, or is that wishful thinking on my part?

@lcawl
Copy link
Contributor Author

lcawl commented Jan 15, 2026

@lcawl are you envisioning that we can move away from relying on that manual work for changelogs and shift more responsibility to the folks writing the PR descriptions as we move towards using this new tool, or is that wishful thinking on my part?

Yes, that's definitely the idea. The Elasticsearch and Elastic Agent teams are already using tools like this, so the benefit is that the changelog info is crafted at the same time as the code changes (and gives everyone a lot more time to see, review, and edit that info if necessary). I played around with having AI reviews of that text in our most recent ON week but haven't returned to that yet. I think that's something we can potentially use to further automate the cleanup of that content in situ.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants