KIE-ISSUES 1056 - Introduce AuthZ Guide for SonataFlow Deployments

[ricardozanini]

Closes apache/incubator-kie-issues#1056

Depends on apache/incubator-kie-kogito-examples#1902

Description:

Please make sure that your PR meets the following requirements:

• You have read the contributions doc
• Pull Request title is properly formatted: Issue-XYZ Subject
• Pull Request title contains the target branch if not targeting main: [0.9.x] Issue-XYZ Subject
• The nav.adoc file has a link to this guide in the proper category
• The index.adoc file has a card to this guide in the proper category, with a meaningful description

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.

[github-actions]

🎊 PR Preview bdb1690 has been successfully built and deployed. See the documentation preview: https://sonataflow-docs-preview-pr-614.surge.sh

[tomasdavidorg]

@ricardozanini I did first round of review (mostly little typos).

I noticed 2 more points:

1. Sometimes you are using modal auxiliary verbs as "will", "should", "can". Shouldn't we use just present tense? + removing you're
2. Looking at the tooling guides and we use bold labels for the UI components. In this guide you use apostrophes. I would suggest to use also the bold text. Wdyt?

If you agree, I can go through the guide and make all the suggestions. 🙂

[ricardozanini]

@ricardozanini I did first round of review (mostly little typos).

I noticed 2 more points:

1. Sometimes you are using modal auxiliary verbs as "will", "should", "can". Shouldn't we use just present tense? + removing you're
2. Looking at the tooling guides and we use bold labels for the UI components. In this guide you use apostrophes. I would suggest to use also the bold text. Wdyt?

If you agree, I can go through the guide and make all the suggestions. 🙂

Nice suggestions, please go ahead!

[tomasdavidorg]

I did a second round, I tried to remove the future tense and replace ui componentss apostrophes with the bold text.

I will do one more to test the documentation together with the example.

[tomasdavidorg]

@ricardozanini Thanks a lot for all the changes 😊. Few more findings when I tested the example together with the documentation.

1. I missed few more ui elements and names to be wrapped with ` or *.
2. I updated 02-sonataflow-route.yaml to be exactly same as in the example.
3. I replaced INGRESS_PORT with INGRESS_URL. The url may differs on different environmetns.

[ricardozanini]

Thank you @tomasdavidorg I appreciate the thorough review! You can check now your changes in the preview.

[tomasdavidorg]

Thank you @tomasdavidorg I appreciate the thorough review! You can check now your changes in the preview.

Checked and looks good to me. Thanks again 🙂.

[ricardozanini]

Thank you for checking, this one was a hell to put together.

[wmedvede]

LGTM, I have added a couple of nitpicks if you want to consider adding.

[ricardozanini]

@kaldesai can you ptal?

[kaldesai]

Minor suggestions! Otherwise, your content looks good to me. Very well written. Thank you!