doc: Tooltip boxes for Rule Unit DSL

[tarilabs]

Adding tooltip boxes in doc for Rule Unit DSL following architectural conversations.

JIRA: none

referenced Pull Requests: none

How to replicate CI configuration locally?

Build Chain tool does "simple" maven build(s), the builds are just Maven commands, but because the repositories relates and depends on each other and any change in API or class method could affect several of those repositories there is a need to use build-chain tool to handle cross repository builds and be sure that we always use latest version of the code for each repository.

build-chain tool is a build tool which can be used on command line locally or in Github Actions workflow(s), in case you need to change multiple repositories and send multiple dependent pull requests related with a change you can easily reproduce the same build by executing it on Github hosted environment or locally in your development environment. See local execution details to get more information about it.

How to retest this PR or trigger a specific build:

• for pull request checks
  Please add comment: Jenkins retest this

• for a specific pull request check
  Please add comment: Jenkins (re)run [drools|kogito-runtimes|kogito-apps|kogito-examples] tests

• for a full downstream build

  • for jenkins job: please add comment: Jenkins run fdb
  • for github actions job: add the label run_fdb

• a compile downstream build please add comment: Jenkins run cdb

• a full production downstream build please add comment: Jenkins execute product fdb

• an upstream build please add comment: Jenkins run upstream

• for quarkus branch checks
  Run checks against Quarkus current used branch
  Please add comment: Jenkins run quarkus-branch

• for a quarkus branch specific check
  Run checks against Quarkus current used branch
  Please add comment: Jenkins (re)run [drools|kogito-runtimes|kogito-apps|kogito-examples] quarkus-branch

• for quarkus main checks
  Run checks against Quarkus main branch
  Please add comment: Jenkins run quarkus-main

• for a specific quarkus main check
  Run checks against Quarkus main branch
  Please add comment: Jenkins (re)run [drools|kogito-runtimes|kogito-apps|kogito-examples] quarkus-main

• for quarkus lts checks
  Run checks against Quarkus lts branch
  Please add comment: Jenkins run quarkus-lts

• for a specific quarkus lts check
  Run checks against Quarkus lts branch
  Please add comment: Jenkins (re)run [drools|kogito-runtimes|kogito-apps|kogito-examples] quarkus-lts

• for native checks
  Run native checks
  Please add comment: Jenkins run native

• for a specific native check
  Run native checks
  Please add comment: Jenkins (re)run [drools|kogito-runtimes|kogito-apps|kogito-examples] native

• for native lts checks
  Run native checks against quarkus lts branch
  Please add comment: Jenkins run native-lts

• for a specific native lts check
  Run native checks against quarkus lts branch
  Please add comment: Jenkins (re)run [drools|kogito-runtimes|kogito-apps|kogito-examples] native-lts

How to backport a pull request to a different branch?

In order to automatically create a backporting pull request please add one or more labels having the following format backport-<branch-name>, where <branch-name> is the name of the branch where the pull request must be backported to (e.g., backport-7.67.x to backport the original PR to the 7.67.x branch).

NOTE: backporting is an action aiming to move a change (usually a commit) from a branch (usually the main one) to another one, which is generally referring to a still maintained release branch. Keeping it simple: it is about to move a specific change or a set of them from one branch to another.

Once the original pull request is successfully merged, the automated action will create one backporting pull request per each label (with the previous format) that has been added.

If something goes wrong, the author will be notified and at this point a manual backporting is needed.

NOTE: this automated backporting is triggered whenever a pull request on main branch is labeled or closed, but both conditions must be satisfied to get the new PR created.

[tkobayas]

I agree to caution compile-time performance optimizations are not needed, but I guess even if the rule is only known at runtime is not the case, some users may still prefer writing rules with Java APIs (Rule Unit DSL).

[tarilabs]

Thank you for the feedback!

Indeed, but as you say:

some users may still prefer writing rules with Java APIs (Rule Unit DSL).

1. This section refers to developer
2. programmatic use is referred explicitly

which is another use-case from user writing Java code and this internal DSL.

I think I need to ponder on a way to further highlight the difference 🤔

[tkobayas]

I meant user=developer. And not imagining another use case. So basically saying the same as what you wrote.

Just I thought that even if the rule is known beforehand, user=developer may want to use Rule Unit DSL.

But the note is okay as-is, it tells enough information. Thanks!

[tarilabs]

Worthy to be indeed worked a bit more I think, thanks for highlighting!

To me there are 2 personas at play here.

The user (which would by default write DRL, can indeed opt for this internal DSL in Java "Rule Unit DSL").
The developer, like we are for the ansible integration, we use Drools and this DSL in another way ("programmatically" at runtime).

I want to highlight clearly that if you are in the second case, you might be missing out from compile-time optimizations.

[tkobayas]

Thanks, that makes sense. I didn't think about the second (developer) case much.

[tarilabs]

I've added fed0af1 in the hope it maybe clarifies better; what do you think?

[tkobayas]

@tarilabs Yes, it's completely clear to me. Thank you!

[tkobayas]

Thanks! Basically I agree your points. Just commented my personal thought (you may ignore it).