PR for SRVLOGIC-36: [DOC] Modularize the Creating your first workflow service section. #239
Conversation
…low service section.
kaldesai
requested review from
radtriste,
MarianMacik,
ricardozanini and
krisv
as code owners
✅ Deploy Preview for tangerine-crostata-04a6bf ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
There was a problem hiding this comment.
Please update the link on the index page for the Creating your first workflow service card
| * xref:getting-started/modules/proc-boostrapping-the-project.adoc[Bootstrapping a project] | ||
| * xref:getting-started/modules/proc-creating-workflow.adoc[Creating a workflow] | ||
| * xref:getting-started/modules/proc-running-application.adoc[Running your workflow application] | ||
| * xref:getting-started/modules/proc-testing-application.adoc[Testing your workflow application] |
There was a problem hiding this comment.
Those should be "internal" links corresponding to titles, like for example, for the first link:
#proc-boostrapping-the-project_Serverless%20Workflow
else you get redirected to the module page and have no access to the rest of the main page.
| * `Inject Mantra`: Injects a `Mantra` message into the response | ||
|
|
||
| .Example Hello World workflow | ||
| image::../../getting-started/images/first-workflow/hello-world-workflow.png[] |
There was a problem hiding this comment.
There are a few comments from @radtriste that we need to take a look. Also, the cards page has a broken link to the "Creating your first workflow service" guide.
| * `{kogito_sw_ga}`: Adds support for workflows. | ||
| * `quarkus-container-image-jib`: Adds support for Container Image Builds. | ||
| * `quarkus-resteasy-jackson`: Adds support for RESTEasy, which is required by the generated REST resources that are used to start the flow process using an HTTP request. | ||
| * `quarkus-smallrye-openapi`: Adds support for Swagger documentation when you run the application in development mode. | ||
| * `--no-code`: Prevents workflow example code from being generated. |
There was a problem hiding this comment.
The list here is not correctly rendered now.
| Knative workflow CLI: | ||
| + | ||
| -- | ||
| Currently, Knative workflow CLI doesn't support yet running workflows locally. You can either: | ||
| .Run your workflow application using Apache Maven | ||
| [source,shell] | ||
| ---- | ||
| mvn clean quarkus:dev | ||
| ---- | ||
| .Run your workflow application using Quarkus CLI | ||
| [source,shell] | ||
| ---- | ||
| quarkus dev | ||
| ---- | ||
| For more information about Knative workflow CLI, see xref:tooling/kn-plugin-workflow-overview.adoc[{context} plug-in for Knative CLI]. | ||
| Also, to deploy and run your workflow application, see xref:cloud/deploying-on-minikube.adoc[Deploying workflow application on Minikube] | ||
| -- | ||
| ==== |
There was a problem hiding this comment.
This part of tabs is not correctly rendered. This was also present before but maybe we can fix it now. The issue is probably a missing second colon, so it should be Knative workflow CLI::
| -- | ||
| ==== | ||
| + | ||
| .Example response |
There was a problem hiding this comment.
| .Example response | |
| .Example output |
sounds better as this is not a REST request.
| include::proc-testing-application.adoc[leveloffset=+1] | ||
|
|
||
|
|
||
| .Additional resources |
There was a problem hiding this comment.
| .Additional resources | |
| == Additional resources |
I think it was better when it was a new section. Now it looks like it is under the testing part.
| @@ -0,0 +1,4 @@ | |||
| .Getting Started | |||
| ** xref:getting-started/modules/create-your-first-workflow-service.adoc[Creating your first workflow service] | |||
There was a problem hiding this comment.
Oh, and one thing, just FYI that now we have the word modules twice in the path, it can cause confusion. But if you are fine with that as a docs team, I am OK with that too.
| + | ||
| .Example response | ||
| [source,shell,subs="attributes"] | ||
| ---- |
There was a problem hiding this comment.
maybe we can shrink these logs and show only what indicates that the service is fully up?
wdyt?
|
Closing as stale, please reopen if still relevant. |
JIRA: SRVLOGIC-36
Description: Heena was working on this JIRA and her PR was #PR204. Instead of working on her PR, I created my own. (To avoid any merge conflicts). Please take a look at the doc changes and share your feedback.
Please make sure that your PR meets the following requirements:
KOGITO-XYZ Subject[0.9.x] KOGITO-XYZ SubjectHow to set up automatic cherry-pick to another branch?
The cherry-pick action allows to setup of automatic cherry-pick from
mainto a specific branch.To allow it, you will need to add the corresponding label with pattern:
backport-{RELEASE_BRANCH}.For example, if a backport to branch
1.26.xis needed, then the label should bebackport-1.26.x.Once the PR is merged, the action will retrieve the commit and cherry-pick it to the desired branch.
NOTE: You can still add label after the merge and it should still be cherry-picked.