[KOGITO-9940] Add documentation for Jobs Service support in the Operator #530

jordigilh · 2024-02-07T17:48:58Z

Extends the documentation to include how to configure Jobs Service using the Operator.

@ricardozanini @kaldesai PTAL

domhanak

Thank you, looks good

serverlessworkflow/modules/ROOT/pages/cloud/operator/enabling-jobs-service.adoc

kaldesai

@jordigilh I have added my suggestions. Please take a look and let me know. Otherwise, your content looks good to me. Thank you! :)

domhanak · 2024-02-21T07:37:40Z

@ricardozanini @jordigilh @kaldesai I accepted the suggestions, only one seemed off. Apologies for the mess, will use the batch suggestion next time.

ricardozanini

Thank you @jordigilh! Just a few adjustments, I believe. Let's keep this one focused on the Jobs Service and its relation with the SonataFlowPlatform. The details about the SonataFlow persistence can be moved to another guide. Feel free to use this same PR, we can adjust the description and title if needed. @tchughesiv @domhanak wdyt?

serverlessworkflow/modules/ROOT/pages/cloud/operator/enabling-jobs-service.adoc

domhanak · 2024-03-06T07:56:29Z

@jakubschwan want to take a look?

ricardozanini · 2024-03-06T13:58:09Z

@jordigilh can you please rebase?

jordigilh · 2024-03-06T14:01:44Z

@jordigilh can you please rebase?

Done

ricardozanini · 2024-03-06T16:16:18Z

@jordigilh there are many WARNs in the build result. Can you please fix them? Otherwise, it will break our branch based on this new incoming PR: #539

jordigilh · 2024-03-06T18:31:51Z

@jordigilh there are many WARNs in the build result. Can you please fix them? Otherwise, it will break our branch based on this new incoming PR: #539

From what I'm reading in the last build, none of these warning are related to the changes I brought in my PR. If they need to be fixed, I reckon they should be in a new PR.

What am I missing?

ricardozanini · 2024-03-06T19:43:02Z

hmmm @jordigilh can you rebase? Maybe that's already fixed in main since we merged a PR that won't allow such errors anymore.

Signed-off-by: Jordi Gil <[email protected]>

… job service Signed-off-by: Jordi Gil <[email protected]>

…r that when provided in the platform CR, it should not contain the schema as it can cause the Jobs Service pod to fail to migrate the existing schema if it's being used by other clients Signed-off-by: Jordi Gil <[email protected]>

…jobs-service.adoc Co-authored-by: Kalyani Desai <[email protected]>

Signed-off-by: Jordi Gil <[email protected]>

jordigilh · 2024-03-06T20:05:20Z

hmmm @jordigilh can you rebase? Maybe that's already fixed in main since we merged a PR that won't allow such errors anymore.

Done.

ricardozanini · 2024-03-06T20:16:41Z

@jordigilh nice now we got the actual errors from your PR:

[20:15:27.833] WARN (asciidoctor): section title out of sequence: expected level 2, got level 3
    file: /home/runner/work/incubator-kie-kogito-docs/incubator-kie-kogito-docs/serverlessworkflow/modules/ROOT/pages/cloud/operator/enabling-jobs-service.adoc:21
    source: /home/runner/work/incubator-kie-kogito-docs/incubator-kie-kogito-docs (branch: HEAD <worktree> | start path: serverlessworkflow)
[20:15:[27](https://github.com/apache/incubator-kie-kogito-docs/actions/runs/8178041793/job/22361529094?pr=530#step:8:28).838] WARN (asciidoctor): section title out of sequence: expected level 2, got level 3
    file: /home/runner/work/incubator-kie-kogito-docs/incubator-kie-kogito-docs/serverlessworkflow/modules/ROOT/pages/cloud/operator/enabling-jobs-service.adoc:47
    source: /home/runner/work/incubator-kie-kogito-docs/incubator-kie-kogito-docs (branch: HEAD <worktree> | start path: serverlessworkflow)
[20:15:27.843] ERROR (asciidoctor): level 0 sections can only be used when doctype is book
    file: /home/runner/work/incubator-kie-kogito-docs/incubator-kie-kogito-docs/serverlessworkflow/modules/ROOT/pages/cloud/operator/enabling-jobs-service.adoc:141
    source: /home/runner/work/incubator-kie-kogito-docs/incubator-kie-kogito-docs (branch: HEAD <worktree> | start path: serverlessworkflow)

Signed-off-by: Jordi Gil <[email protected]>

jordigilh requested review from domhanak and MarianMacik as code owners February 7, 2024 17:48

ricardozanini requested review from ricardozanini and removed request for MarianMacik February 7, 2024 17:59

domhanak approved these changes Feb 9, 2024

View reviewed changes