Skip to content

Conversation

@nikku
Copy link
Member

@nikku nikku commented Oct 31, 2025

Description

Our existing documentation on deprecating element templates is insufficient as highlighted in this conversation.

This PR improves the documentation, ensures that the recommended deprecation pattern is highlighted first. It also aligns the section with other sections in the document and links upstream documentation.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the Documentation team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and are in the /docs directory (version 8.8).
  • My changes are for an already released minor and are in a /versioned_docs directory.

@nikku nikku requested review from a team, jfriedenstab, lmbateman and yT0n1 October 31, 2025 09:37
@nikku nikku self-assigned this Oct 31, 2025
@nikku nikku added the component:modeler Issues related with Modeler project label Oct 31, 2025
@nikku nikku requested review from Buckwich and jarekdanielak and removed request for a team October 31, 2025 09:37
@nikku nikku added the low prio There is no urgency with this change. label Oct 31, 2025
@camunda-docs-pr-automation camunda-docs-pr-automation bot moved this to 👀 In Review in Documentation Team Oct 31, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

@nikku
Copy link
Member Author

nikku commented Oct 31, 2025

Backported to 8.8, deprecated is undocumented in <= 8.7 (ref).

@nikku nikku force-pushed the element-templates-deprecated-property-details branch from 17da92e to 4f9633a Compare October 31, 2025 10:27
@nikku nikku marked this pull request as ready for review October 31, 2025 10:27
Copy link
Contributor

@lmbateman lmbateman left a comment

Choose a reason for hiding this comment

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

Looks good! Made a few minor suggestions, but none are essential.

Copy link
Contributor

@lmbateman lmbateman left a comment

Choose a reason for hiding this comment

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

Thanks for the changes! Just two minor typos; otherwise, looks great.

@nikku nikku force-pushed the element-templates-deprecated-property-details branch from 281d603 to 53a4310 Compare November 3, 2025 07:21
@nikku nikku requested a review from lmbateman November 3, 2025 07:22
@nikku nikku force-pushed the element-templates-deprecated-property-details branch from 53a4310 to 21dd5d7 Compare November 3, 2025 08:59
@nikku nikku force-pushed the element-templates-deprecated-property-details branch from 21dd5d7 to 8bab7da Compare November 3, 2025 12:41
lmbateman
lmbateman previously approved these changes Nov 3, 2025
Copy link
Contributor

@lmbateman lmbateman left a comment

Choose a reason for hiding this comment

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

Two minor proofreading suggestions. Approving in advance for expediency.

@nikku nikku requested a review from lmbateman November 3, 2025 13:35
@nikku
Copy link
Member Author

nikku commented Nov 3, 2025

Should be all clear now. @camunda/tech-writers looking for your ✔️

@nikku nikku merged commit 9ecd531 into main Nov 4, 2025
8 checks passed
@nikku nikku deleted the element-templates-deprecated-property-details branch November 4, 2025 13:33
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in Documentation Team Nov 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component:modeler Issues related with Modeler project low prio There is no urgency with this change.

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

4 participants