Skip to content

Add changelog directives to Serverless release notes#6599

Open
lcawl wants to merge 6 commits into
elastic:mainfrom
lcawl:clean-bundles
Open

Add changelog directives to Serverless release notes#6599
lcawl wants to merge 6 commits into
elastic:mainfrom
lcawl:clean-bundles

Conversation

@lcawl

@lcawl lcawl commented May 21, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR tests the use of changelog directives in the Cloud Serverless release notes rather than file inclusion with markdown files.

NOTE: This PR cannot be merged until elastic/docs-builder#3653 is merged (and the bundles in S3 are re-scrubbed) since otherwise some links are lost.

Generative AI disclosure

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

@github-actions

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions

github-actions Bot commented May 21, 2026

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

Vale Linting Results

Summary: 1 suggestion found

💡 Suggestions (1)
File Line Rule Message
release-notes/elastic-cloud-serverless/breaking-changes.md 17 Elastic.WordChoice Consider using 'deactivates, deselects, hides, turns off, makes unavailable' instead of 'Disables', 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.

@lcawl lcawl marked this pull request as ready for review July 3, 2026 20:25
@lcawl lcawl requested review from a team as code owners July 3, 2026 20:25

@vishaangelova vishaangelova left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The changes in this PR LGTM, but I noticed a couple of rendering issues:

  1. In the known issue dropdowns, the code formatting syntax appears in the title, but it’s not rendered, so should we omit it instead?
Screenshot 2026-07-06 at 9 49 46
  1. For the deprecations, the linked issues appear with an additional []:
Screenshot 2026-07-06 at 9 52 33

@lcawl

lcawl commented Jul 10, 2026

Copy link
Copy Markdown
Contributor Author

The changes in this PR LGTM, but I noticed a couple of rendering issues:

  1. In the known issue dropdowns, the code formatting syntax appears in the title, but it’s not rendered, so should we omit it instead?

I created elastic/docs-builder#3637 to follow up on this rendering issue.

  1. For the deprecations, the linked issues appear with an additional []:

Ditto, I've created elastic/docs-builder#3638

@lcawl lcawl mentioned this pull request Jul 13, 2026
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants