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

PR for SRVLOGIC-83: [DOC] Remove "Kogito" name from Serverless Logic documents #100

Merged
merged 2 commits into from
Oct 9, 2023

Conversation

kaldesai
Copy link

@kaldesai kaldesai commented Sep 15, 2023

@openshift-ci-robot
Copy link

@kaldesai: This pull request references SRVLOGIC-83 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.15.0" version, but no target version was set.

In response to this:

Tracking JIRA: https://issues.redhat.com/browse/SRVLOGIC-83

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@netlify
Copy link

netlify bot commented Sep 15, 2023

Deploy Preview for jazzy-shortbread-5f62b7 ready!

Name Link
🔨 Latest commit 94929e4
🔍 Latest deploy log https://app.netlify.com/sites/jazzy-shortbread-5f62b7/deploys/650d622f44a7cd000892d24c
😎 Deploy Preview https://deploy-preview-100--jazzy-shortbread-5f62b7.netlify.app/docs/latest/serverless-logic/core/custom-functions-support
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@openshift-ci-robot
Copy link

@kaldesai: This pull request references SRVLOGIC-83 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.15.0" version, but no target version was set.

In response to this:

Tracking JIRA: https://issues.redhat.com/browse/SRVLOGIC-83

Doc preview: Function accessing contextual data

Required reviews from @krisv and @ricardozanini

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@kaldesai kaldesai changed the title [WIP] PR for SRVLOGIC-83: [DOC] Remove "Kogito" name from Serverless Logic documents PR for SRVLOGIC-83: [DOC] Remove "Kogito" name from Serverless Logic documents Sep 15, 2023
Copy link
Collaborator

@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.

@kaldesai Is this PR complete? By looking at the jira it should remove Kogito references. But for example there is still Kogito Serverless Workflow Visualization feature mentioned in the docs.

@kaldesai
Copy link
Author

@MarianMacik

Kogito Serverless Workflow Visualization is a UI element. It is a checkbox. So I kept it as it is.
I am attaching the following screenshot of the same:
image

If we can change the name over there I will update it in the docs.

@krisv @ricardozanini Can you please verify?

@MarianMacik
Copy link
Collaborator

@kaldesai Just found one more thing which might be good to rename perhaps:

When a Serverless Workflow function is called, Kogito identifies the proper `WorkflowWorkItemHandler` instance to be used for that function type (using the handler name associated with that type by the deployment project) and then invokes the `internalExecute` method. The `Map` parameter contains the function arguments defined in the workflow, and the `WorkItem` parameter contains the metadata information added to the handler by the deployment project. Hence, the `executeWorkItem` implementation has an access to all the information needed to perform the computational logic intended for that custom type.

Everything else is either UI-related or there are example outputs or it is a name of an addon (Kogito Knative Eventing add-on), where it doesn't make sense to rename it, it would only cause more confusion. Looks good to me otherwise.

@ricardozanini
Copy link
Member

@kaldesai since 1.30 is out we can merge this. However, we also need to cherry-pick everything from 1.40.x branch here: https://github.com/apache/incubator-kie-kogito-docs/tree/1.40.x-prod

@kaldesai
Copy link
Author

@kaldesai Just found one more thing which might be good to rename perhaps:

When a Serverless Workflow function is called, Kogito identifies the proper `WorkflowWorkItemHandler` instance to be used for that function type (using the handler name associated with that type by the deployment project) and then invokes the `internalExecute` method. The `Map` parameter contains the function arguments defined in the workflow, and the `WorkItem` parameter contains the metadata information added to the handler by the deployment project. Hence, the `executeWorkItem` implementation has an access to all the information needed to perform the computational logic intended for that custom type.

Everything else is either UI-related or there are example outputs or it is a name of an addon (Kogito Knative Eventing add-on), where it doesn't make sense to rename it, it would only cause more confusion. Looks good to me otherwise.

@MarianMacik I have incorporated your suggestion and renamed it.

Copy link
Collaborator

@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 @kaldesai!

@openshift-ci
Copy link

openshift-ci bot commented Oct 5, 2023

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: kaldesai, krisv, MarianMacik, ricardozanini

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ricardozanini ricardozanini merged commit 62e06d3 into openshift-knative:master Oct 9, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants