-
Notifications
You must be signed in to change notification settings - Fork 195
Serverless release note test #4627
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Vale Linting ResultsSummary: 2 warnings, 8 suggestions found
|
| 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.
🔍 Preview links for changed docs |
|
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? |
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. |
Summary
This PR is a test of the
docs-builder changelogadd anddocs-builder changelog bundlecommands.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
--subsectionsoption, the output looks like this:With the
--subsectionsoption, the output looks like this: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