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

[KOGITO-9838] Add a troubleshooting guide for remote service invocations #507

Merged
merged 3 commits into from
Sep 28, 2023

Conversation

ricardozanini
Copy link
Member

JIRA:
https://issues.redhat.com/browse/KOGITO-9838

Description:
In this PR, we complement the work in KOGITO-9838 by adding a quick troubleshooting guide for remote service invocations. We should keep updating this guide with more information.

apache/incubator-kie-kogito-runtimes#3238

Please make sure that your PR meets the following requirements:

  • You have read the contributions doc
  • Pull Request title is properly formatted: KOGITO-XYZ Subject
  • Pull Request title contains the target branch if not targeting main: [0.9.x] KOGITO-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.

Signed-off-by: Ricardo Zanini <zanini@redhat.com>
Copy link
Contributor

@fjtirado fjtirado left a comment

Choose a reason for hiding this comment

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

@ricardozanini
I think having a troubleshooting guide is a must (so really good idea) and the content you write in no time is really good, but I would add a longer introduction and convert the current in just one section, "hhtp troubleshooting", so current sections become sub-sections of that one.
That way, in the future, we can add more sections, for example GRPC troubleshooting or JQ troubleshooting.
wdyt?

@fjtirado fjtirado self-requested a review September 27, 2023 13:48
Copy link
Member

@MarianMacik MarianMacik left a comment

Choose a reason for hiding this comment

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

Looks good, just minor suggestions.

ricardozanini and others added 2 commits September 27, 2023 15:31
Co-authored-by: Marián Macik <macik.marian@gmail.com>
…tions

Signed-off-by: Ricardo Zanini <zanini@redhat.com>
@ricardozanini ricardozanini changed the title [KOGITO-9838] Add a troubleshooting guide for remove service invocations [KOGITO-9838] Add a troubleshooting guide for remote service invocations Sep 27, 2023
@ricardozanini
Copy link
Member Author

@fjtirado can you take a look?

Copy link
Member

@MarianMacik MarianMacik left a comment

Choose a reason for hiding this comment

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

Looks good now, thanks!

@ricardozanini ricardozanini merged commit 6df5989 into apache:main Sep 28, 2023
1 check passed
@ricardozanini ricardozanini deleted the kogito-9838 branch September 28, 2023 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants