Skip to content

feat(desktop-modeler): create template versioning section #5778

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

nikku
Copy link
Member

@nikku nikku commented May 14, 2025

Description

This PR ensures improves the existing template definition documentation:

  • Provides linking of template parts (engine and version)
  • Introduces a template version documentation
  • Link to upstream documentation where it provides value

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, Buckwich and philippfromme and removed request for a team May 14, 2025 10:46
@akeller akeller moved this to 👀 In Review in Documentation Team May 14, 2025
Copy link
Contributor

👋 🤖 🤔 Hello, @nikku! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.7/.

  • docs/components/modeler/desktop-modeler/element-templates/defining-templates.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@nikku nikku added component:modeler Issues related with Modeler project component:desktop-modeler Issues related with Desktop Modeler labels May 14, 2025
…ning-templates.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
nikku and others added 2 commits May 14, 2025 13:23
…ning-templates.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@philippfromme
Copy link
Contributor

I like the general direction but following the link and seeing the graphics at https://github.com/bpmn-io/element-templates/blob/main/docs/LIFE_CYCLE.md#overview I think we could improve that (I find it hard to comprehend without screenshots) or just link to the existing documentation that covers the entire lifecycle (though engine compatibility is currently missing). I think we need to cover 5 different states: https://miro.com/app/board/uXjVI1a7lHU=/

@nikku
Copy link
Member Author

nikku commented May 22, 2025

I think we could improve that (I find it hard to comprehend without screenshots)

@philippfromme What is hard to comprehend about the graphics? Keep in mind this is developer, not user documentation.

@philippfromme
Copy link
Contributor

I guess it's just me. 😅

@christinaausley
Copy link
Contributor

christinaausley commented May 28, 2025

@philippfromme I will keep an eye on this page with PushFeedback (which tracks incoming feedback from users on each page) to see if we get any additional thoughts on this. For example:

Screenshot 2025-05-28 at 11 43 47 AM

On the backend I can see if anyone leaves comments with their thumbs up/down as well.

@nikku Is this still a WIP or ready to be moved out of draft and merged?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:desktop-modeler Issues related with Desktop Modeler component:modeler Issues related with Modeler project
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

4 participants