Serverless release note test #4627
Draft
+482
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
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.
Contributor
🔍 Preview links for changed docs |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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