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-9454] Documenting java flow library #585

Merged
merged 14 commits into from
Mar 21, 2024
Merged

Conversation

fjtirado
Copy link
Contributor

@fjtirado fjtirado commented Mar 14, 2024

Documents java flow library

Closes/Fixes/Resolves #ISSUE-NUMBER

Description:

https://issues.redhat.com/browse/KOGITO-9454

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.

Copy link
Contributor

github-actions bot commented Mar 14, 2024

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

@fjtirado fjtirado force-pushed the KOGITO-9454 branch 4 times, most recently from 964cd70 to 8905e2b Compare March 14, 2024 17:24
Copy link
Contributor

@gmunozfe gmunozfe 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 to me, well done @fjtirado !

@ricardozanini
Copy link
Member

@kaldesai can you ptal?

Copy link
Member

@ricardozanini ricardozanini left a comment

Choose a reason for hiding this comment

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

Seems fine as a first approach, but I'm wondering where to put this guide. @domhanak do you have a suggestion?

Copy link
Contributor

@kaldesai kaldesai left a comment

Choose a reason for hiding this comment

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

@fjtirado I have some minor suggestions. Otherwise, your content looks good to me. Thank you!

@domhanak domhanak requested review from domhanak and removed request for domhanak March 20, 2024 12:55
Copy link
Contributor

@domhanak domhanak left a comment

Choose a reason for hiding this comment

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

I added a few suggestions, let me know

@fjtirado fjtirado requested a review from krisv as a code owner March 20, 2024 14:39
@fjtirado fjtirado requested a review from domhanak March 20, 2024 14:39
@fjtirado fjtirado merged commit 381da7c into apache:main Mar 21, 2024
2 checks passed
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.

5 participants