feat: replace raw alpha warnings with admonitions when generating C8 REST API docs #4579
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.
Description
In camunda/camunda#24340, we removed all docs-specific formatting from the upstream spec. We'd already accounted for adding links in #4541, but we also need to add admonitions for alpha warnings.
This PR turns a text-only alpha warning into a
:::note
admonition.This injection has no effect on the current docs spec, because the admonitions are already there -- this is why there are no files changed other than the generation strategy. However, when camunda/camunda#24340 makes it to this project via the weekly spec sync, our spec will be missing admonitions, and we'll want to regenerate with this new step.
When should this change go live?
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).My changes require an Engineering review, and I've assigned the Engineering DRI or delegate.
My changes require a technical writer review, and I've assigned @camunda/tech-writers as a reviewer.
My changes require a docs infrastructure review.