Conversation
Docs preview (local build)Handbook preview: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/4073/ Sample changed pages: |
Mpdreamz
left a comment
There was a problem hiding this comment.
Reviewed the docs-only workflow update. The late-note guidance is consistent across the CLI and release-notes pages, the reserved .amend-notes ownership is clear, and CI is green. Looks ready once the PR is out of draft.
There was a problem hiding this comment.
Approved.
What is this? | From workflow: PR Review
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
There was a problem hiding this comment.
Requesting changes.
What is this? | From workflow: PR Review
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
|
|
||
| `changelog remove` only deletes local YAML. It does not change a published bundle or the changelog pool. | ||
|
|
||
| - If the note is already embedded in the parent bundle, use `changelog bundle-amend --remove` and upload the numbered sidecar. Refer to [](/data/release-notes/bundle.md#changelog-bundle-notes-after-ship). |
There was a problem hiding this comment.
This step says to upload the numbered sidecar, but it omits the required artifact type. A reader can reasonably run changelog upload --artifact-type changelog, which won’t amend published bundles. Please make this explicit here (for example: upload {parent}.amend-N.yaml with docs-builder changelog upload --artifact-type bundle).
Summary
Document adding and removing notes from published bundles
Relates to #4072 (documentation of all but the missing functionality)
Details
Canonical how-to is now a subsection of Amend bundles: Add or remove notes after a bundle ships.
Add a late note:
changelog note→changelog upload --artifact-type changelog. Do not usebundle-amend --add; the scrubber writes{parent}.amend-notes.yaml.Remove: local
changelog removenever changes published bundles. Notes already in the parent can usebundle-amend --removeplus uploadingamend-N. Notes that exist only in.amend-noteshave no unpublish command. A warning covers the scrubber putting a still-published pool file back.The same facts are linked from
cmd-note.md,cmd-bundle-amend.md,create.md,cmd-remove.md,overview.md,cmd-upload.md, andchangelog-bundle-registry.md. None of those pages tell authors to delete S3 objects.Generative AI disclosure
Tool(s) and model(s) used: Cursor Grok 4.6