-
Notifications
You must be signed in to change notification settings - Fork 181
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
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
5ad6ec9
to
ad75c45
Compare
7799846
to
53a2c4d
Compare
docs/components/modeler/bpmn/business-rule-tasks/business-rule-tasks.md
Outdated
Show resolved
Hide resolved
53a2c4d
to
cfca027
Compare
@HanselIdes Two points from from the "Documentation Planning" section in https://github.com/camunda/product-hub/issues/435#issuecomment-1241783885 are still missing:
=> 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).
=> I haven't mentioned Operate yet, because the implementation will not be done for the upcoming alpha. |
There was a problem hiding this 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
docs/components/best-practices/modeling/choosing-the-resource-binding-type.md
Show resolved
Hide resolved
@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 |
@jfriedenstab Do you require a TW review on this for the alpha 5 release? |
@mesellings Yes, I do :) I just wanted to address the other comments first. |
@HanselIdes: I've added a short sentence on where to set the version tag to the description of the 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. |
@jfriedenstab I'll review this now for you 👍 |
@jfriedenstab Due to the size of the PR can I make edits/commits directly to the branch? |
Sure, go ahead 🙂 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
224083d
There was a problem hiding this 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 👍
Thanks a lot, @mesellings! 👍🏻 |
Description
Add documentation on the new
versionTag
binding type for linked resources (introduced with8.6.0-alpha5
).Closes #4221.
Part of https://github.com/camunda/product-hub/issues/435.
When should this change go live?
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).