-
Notifications
You must be signed in to change notification settings - Fork 182
BXMSDOC-6416-master: Add multi-DRD content to PAM/DM #2861
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
Conversation
doc-content/drools-docs/src/main/asciidoc/DMN/dmn-drd-components-ref.adoc
Show resolved
Hide resolved
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.
@sterobin Have added a few suggestions, rest looks good.
Thank you so much.
|
||
* *Create*: Use this option to create a nested DRD where you can separately define the DMN components and diagram for the selected node. | ||
* *Add to*: If you already created a nested DRD, use this option to add the selected node to an existing DRD. | ||
* *Remove*: If the node that you selected is already within a nested DRD, use this option to remove the node from that nested DRD. |
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.
Can we shorten the descriptions for these options, for example:
- Create: To create a nested DRD
- Add to: To add a node to an existing DRD
- Remove: To remove a node from a nested DRD
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.
@hmanwani-rh This is the format we use elsewhere for many of the other similar bullet points, even in this doc. Either way, the preferred shortened alternative would actually be "Creates a nested ...", but that removes user action. What you suggest would be more user centric, but just leads to a sentence that the reader expects to be complete, and then ends. So a little jarring/confusing. So I typically use the full version to ensure it's user centric, but this is a topic for group discussion at some point.
doc-content/drools-docs/src/main/asciidoc/DMN/dmn-model-creating-multiples-proc.adoc
Outdated
Show resolved
Hide resolved
image::dmn/dmn-drd-actions-rename.png[] | ||
-- | ||
. In the new canvas for the nested DRD, design the flow and logic for all required components in this portion of the DMN model, as usual. | ||
. Continue adding and defining any other nested DRDs for your decision model and save the completed DMN file. |
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.
. Continue adding and defining any other nested DRDs for your decision model and save the completed DMN file. | |
. Continue adding and defining other nested DRDs for your decision model and save the completed DMN file. |
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.
In this case, I like "any" and we use the same at the end of the other DMN model instructions. It suggests a feeling that you might or might not have others to create, and it's up to you. Without "any", we're commanding them to create other ones, but we're really just saying, create any other ones, meaning if needed.
doc-content/drools-docs/src/main/asciidoc/DMN/dmn-model-creating-multiples-proc.adoc
Outdated
Show resolved
Hide resolved
I don't think we have the DRG tab contents completely right :-/ I got the same understanding as is documented here, but then after discussion with @danielzhe it was made clear that DRG panel should contain all the Decision components that exist across all DRDs. So DRG should serve as sort of an index of all Decision components. In any case - it would be probably safer to use just DRDs in the Decision breakout example (Decision spanning multiple DRDs) screenshots - not refer to the DRG as the high-level view of the model (cause even though this might be true now, it could set wrong expectations and pose unnecessary burden on users when we change behavior of DRG panel). E.g. |
@jstastny-cz I think I follow, but not quite sure. Either way, I think the easier approach for docs is to document what is true today, and then if that changes at some point, update the docs/screenshots accordingly. Otherwise I can't visualize what you're describing and it's difficult to document features that aren't a reality yet. If that Jira is going to be merged by end of this week and we'll have access to the latest UI showing the changes you're describing for this release, then sure, can hold this PR and then update the screenshots accordingly next week. But if this is at risk for this release as you say, then I see no problem in documenting the DMN designer as it is today with how users will see it once released, and then update it as needed for next release. Let me know if I've misunderstood. |
@sterobin @jstastny-cz Given the timeframe the KOGITO-2667 won't be merged this week. Thus, I agree with Stetson, let's document what we have today and change/improve it in the future. |
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.
Thank you, @sterobin.
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.
Approving, the docs describe well the feature in its current state.
* BXMSDOC-6416-master: Add multi-DRD content for DMN. * Peer review.
* BXMSDOC-6416-master: Add multi-DRD content for DMN. * Peer review.
* BXMSDOC-6416-master: Add multi-DRD content for DMN. * Peer review.
* BXMSDOC-6416-master: Add multi-DRD content for DMN. * Peer review.
* BXMSDOC-6416-master: Add multi-DRD content for DMN. * Peer review.
* BXMSDOC-6416-master: Add multi-DRD content for DMN. * Peer review.
* BXMSDOC-6416-master: Add multi-DRD content for DMN. * Peer review.
* BXMSDOC-6416-master: Add multi-DRD content for DMN. * Peer review.
* BXMSDOC-6416-master: Add multi-DRD content for DMN. * Peer review.
* BXMSDOC-6416-master: Add multi-DRD content for DMN. * Peer review.
@karreiro @jstastny-cz @hmanwani-rh Ready for your review. Links below.
Links: