Skip to content
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

docs: document "version tag" binding for linked resources #4248

Merged
merged 4 commits into from
Sep 6, 2024

Conversation

jfriedenstab
Copy link
Contributor

@jfriedenstab jfriedenstab commented Sep 3, 2024

Description

Add documentation on the new versionTag binding type for linked resources (introduced with 8.6.0-alpha5).

Closes #4221.
Part of https://github.com/camunda/product-hub/issues/435.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@jfriedenstab jfriedenstab added component:zeebe Issues related with Zeebe project component:modeler Issues related with Modeler project 8.6.0-alpha5 September 2024 alpha release labels Sep 3, 2024
@jfriedenstab jfriedenstab self-assigned this Sep 3, 2024

This comment was marked as resolved.

@jfriedenstab jfriedenstab force-pushed the 4221-document-version-tag-binding-type branch from 5ad6ec9 to ad75c45 Compare September 5, 2024 06:32
@jfriedenstab jfriedenstab changed the title docs: document "version tag" binding for call activities, business rule tasks, and user tasks docs: document "version tag" binding for linked resources Sep 5, 2024
@jfriedenstab jfriedenstab force-pushed the 4221-document-version-tag-binding-type branch 2 times, most recently from 7799846 to 53a2c4d Compare September 5, 2024 13:09
@jfriedenstab jfriedenstab marked this pull request as ready for review September 5, 2024 13:20
@jfriedenstab
Copy link
Contributor Author

@HanselIdes Two points from from the "Documentation Planning" section in https://github.com/camunda/product-hub/issues/435#issuecomment-1241783885 are still missing:

The user learns where to find the version tag in the Modeler for BPMN, form, and DMN

=> For DMN, I could add a section on the version tag to https://docs.camunda.io/docs/next/components/modeler/dmn/decision-table/, but there's no equivalent page for BPMN and Forms (yet).

The user learns where to look for the version tag in Operate for call activities. The version tag of forms and decisions cannot be found in Operate

=> I haven't mentioned Operate yet, because the implementation will not be done for the upcoming alpha.

Copy link
Contributor

@HanselIdes HanselIdes left a comment

Choose a reason for hiding this comment

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

I added 2 non-blocking comments. I didn't see any updates to the Operate docs. Are these coming in a different PR? I saw your comment

@HanselIdes
Copy link
Contributor

The user learns where to find the version tag in the Modeler for BPMN, form, and DMN
=> For DMN, I could add a section on the version tag to https://docs.camunda.io/docs/next/components/modeler/dmn/decision-table/, but there's no equivalent page for BPMN and Forms (yet).

@jfriedenstab I think a description of where to find the version tag field is sufficient - a screenshot is not necessary.

It's important to me that the user learns that the power of version tag and that it comes with a different kind of risk. That's why I suggested a reminder when choosing the version binding in my PR review

@mesellings
Copy link
Contributor

@jfriedenstab Do you require a TW review on this for the alpha 5 release?

@jfriedenstab
Copy link
Contributor Author

@mesellings Yes, I do :) I just wanted to address the other comments first.

@jfriedenstab
Copy link
Contributor Author

I think a description of where to find the version tag field is sufficient

@HanselIdes: I've added a short sentence on where to set the version tag to the description of the versionTag type now, so that it's mentioned somewhere at least.

I'd say we should still further improve the docs and add a page that explains the general properties of a process (id, name, version tag) under the BPMN section (similar to the DMN page I linked above), but that could be done as a follow-up.

@mesellings mesellings self-assigned this Sep 6, 2024
@mesellings
Copy link
Contributor

@jfriedenstab I'll review this now for you 👍

@mesellings
Copy link
Contributor

@jfriedenstab Due to the size of the PR can I make edits/commits directly to the branch?

@jfriedenstab
Copy link
Contributor Author

@jfriedenstab Due to the size of the PR can I make edits/commits directly to the branch?

Sure, go ahead 🙂

HanselIdes
HanselIdes previously approved these changes Sep 6, 2024
Copy link
Contributor

@HanselIdes HanselIdes left a comment

Choose a reason for hiding this comment

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

LGTM

wollefitz
wollefitz previously approved these changes Sep 6, 2024
@mesellings mesellings dismissed stale reviews from wollefitz and HanselIdes via 224083d September 6, 2024 13:42
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

@jfriedenstab Reviewed and approved, just a few minor text edits, mostly for passive voice > active voice. Lgtm 👍

@jfriedenstab
Copy link
Contributor Author

Thanks a lot, @mesellings! 👍🏻

@jfriedenstab jfriedenstab merged commit ccca3bd into main Sep 6, 2024
7 checks passed
@jfriedenstab jfriedenstab deleted the 4221-document-version-tag-binding-type branch September 6, 2024 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.6.0-alpha5 September 2024 alpha release component:modeler Issues related with Modeler project component:zeebe Issues related with Zeebe project
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Document new binding type versionTag for linked resources
4 participants