KOGITO-9455: Create the getting started guide to describe how to run … #421

domhanak · 2023-07-31T07:34:50Z

…workflow projects

@ricardozanini could you please suggest if all-together in one file is OK, or if we should split some parts to different sections. Imho keeping it in one file like this makes it easier for users not familiar with our docs.

Just the getting started guide a follow-up guide where we expand the hello-world workflow with supporting files is required imho. Will be done as part of - https://issues.redhat.com/browse/KOGITO-9457

Adds new file with guide containing create, run and deploy showcases to begin development of SonataFlow project using operator first approach.

JIRA:KOGITO-9455

Description:
Adds new file with guide containing create, run and deploy showcases to begin development of SonataFlow project using operator first approach.

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.

…workflow projects Adds new file with guide containing create, run and deploy showcases to begin development of SonataFlow project using operator first approach.

netlify · 2023-07-31T07:34:55Z

✅ Deploy Preview for tangerine-crostata-04a6bf ready!

Name	Link
🔨 Latest commit	`c3e9de0`
🔍 Latest deploy log	https://app.netlify.com/sites/tangerine-crostata-04a6bf/deploys/64dc74555127d800074bda57
😎 Deploy Preview	https://deploy-preview-421--tangerine-crostata-04a6bf.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

ricardozanini

Looks neat! I'm hoping to hear from others, but I think we can keep the whole instructions in a single guide. It seems simple enough.

I left a few comments if you don't mind. Thank you! 🙏

...es/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc

kaldesai

LGTM!

domhanak · 2023-08-02T08:04:28Z

@ricardozanini thanks, fixing!

domhanak · 2023-08-02T11:32:59Z

@kaldesai thanks as well, incorporated your comments also

...es/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc

Expplains basics fo accesing the project via REST using CURL.

...es/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc

…ate-your-first-workflow-service-with-kn-cli-and-vscode.adoc Co-authored-by: Marián Macik <[email protected]>

ricardozanini · 2023-08-30T11:52:44Z

@ederign can you or someone from tooling please review?

#421) * KOGITO-9455: Create the getting started guide to describe how to run workflow projects Adds new file with guide containing create, run and deploy showcases to begin development of SonataFlow project using operator first approach. * KOGITO-9455: Update the initial chapter texts to make it sound bette * Fix typos, use empty brackets for referrences * Reference our guide for operator install * KOGITO-9455: Improve Testing your application section Expplains basics fo accesing the project via REST using CURL. * KOGITO-9455: Fix typos, invalid page refs and improve text * Fix typo in serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc Co-authored-by: Marián Macik <[email protected]> * KOGITO-9455: Add guide to nav.adoc and index.adoc --------- Co-authored-by: Marián Macik <[email protected]>

…be how to run … (#475) KOGITO-9455: Create the getting started guide to describe how to run … (#421) * KOGITO-9455: Create the getting started guide to describe how to run workflow projects Adds new file with guide containing create, run and deploy showcases to begin development of SonataFlow project using operator first approach. * KOGITO-9455: Update the initial chapter texts to make it sound bette * Fix typos, use empty brackets for referrences * Reference our guide for operator install * KOGITO-9455: Improve Testing your application section Expplains basics fo accesing the project via REST using CURL. * KOGITO-9455: Fix typos, invalid page refs and improve text * Fix typo in serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc * KOGITO-9455: Add guide to nav.adoc and index.adoc --------- Co-authored-by: Dominik Hanák <[email protected]> Co-authored-by: Marián Macik <[email protected]>

…w to run … (#477) KOGITO-9455: Create the getting started guide to describe how to run … (#421) * KOGITO-9455: Create the getting started guide to describe how to run workflow projects Adds new file with guide containing create, run and deploy showcases to begin development of SonataFlow project using operator first approach. * KOGITO-9455: Update the initial chapter texts to make it sound bette * Fix typos, use empty brackets for referrences * Reference our guide for operator install * KOGITO-9455: Improve Testing your application section Expplains basics fo accesing the project via REST using CURL. * KOGITO-9455: Fix typos, invalid page refs and improve text * Fix typo in serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc * KOGITO-9455: Add guide to nav.adoc and index.adoc --------- Co-authored-by: Dominik Hanák <[email protected]> Co-authored-by: Marián Macik <[email protected]>

…w to run … (#474) KOGITO-9455: Create the getting started guide to describe how to run … (#421) * KOGITO-9455: Create the getting started guide to describe how to run workflow projects Adds new file with guide containing create, run and deploy showcases to begin development of SonataFlow project using operator first approach. * KOGITO-9455: Update the initial chapter texts to make it sound bette * Fix typos, use empty brackets for referrences * Reference our guide for operator install * KOGITO-9455: Improve Testing your application section Expplains basics fo accesing the project via REST using CURL. * KOGITO-9455: Fix typos, invalid page refs and improve text * Fix typo in serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc * KOGITO-9455: Add guide to nav.adoc and index.adoc --------- Co-authored-by: Dominik Hanák <[email protected]> Co-authored-by: Marián Macik <[email protected]>

…w to run … (#476) KOGITO-9455: Create the getting started guide to describe how to run … (#421) * KOGITO-9455: Create the getting started guide to describe how to run workflow projects Adds new file with guide containing create, run and deploy showcases to begin development of SonataFlow project using operator first approach. * KOGITO-9455: Update the initial chapter texts to make it sound bette * Fix typos, use empty brackets for referrences * Reference our guide for operator install * KOGITO-9455: Improve Testing your application section Expplains basics fo accesing the project via REST using CURL. * KOGITO-9455: Fix typos, invalid page refs and improve text * Fix typo in serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc * KOGITO-9455: Add guide to nav.adoc and index.adoc --------- Co-authored-by: Dominik Hanák <[email protected]> Co-authored-by: Marián Macik <[email protected]>

…w to run … (#478) KOGITO-9455: Create the getting started guide to describe how to run … (#421) * KOGITO-9455: Create the getting started guide to describe how to run workflow projects Adds new file with guide containing create, run and deploy showcases to begin development of SonataFlow project using operator first approach. * KOGITO-9455: Update the initial chapter texts to make it sound bette * Fix typos, use empty brackets for referrences * Reference our guide for operator install * KOGITO-9455: Improve Testing your application section Expplains basics fo accesing the project via REST using CURL. * KOGITO-9455: Fix typos, invalid page refs and improve text * Fix typo in serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc * KOGITO-9455: Add guide to nav.adoc and index.adoc --------- Co-authored-by: Dominik Hanák <[email protected]> Co-authored-by: Marián Macik <[email protected]>

KOGITO-9455: Create the getting started guide to describe how to run …

5cbeac0

…workflow projects Adds new file with guide containing create, run and deploy showcases to begin development of SonataFlow project using operator first approach.

domhanak requested review from kaldesai, radtriste and MarianMacik as code owners July 31, 2023 07:34

domhanak requested review from ederign and ricardozanini July 31, 2023 07:34

domhanak added the DO_NOT_MERGE 🙅 don't merge this PR label Jul 31, 2023

KOGITO-9455: Update the initial chapter texts to make it sound bette

6f339a2

ricardozanini added backport-1.40.x backport-1.41.x backport-1.40.x-prod backport-1.42.x labels Jul 31, 2023

ricardozanini reviewed Jul 31, 2023

View reviewed changes

kaldesai reviewed Aug 1, 2023

View reviewed changes

...es/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc Outdated Show resolved Hide resolved

kaldesai reviewed Aug 1, 2023

View reviewed changes

...es/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc Outdated Show resolved Hide resolved

kaldesai approved these changes Aug 1, 2023

View reviewed changes

domhanak added 2 commits August 2, 2023 13:29

Fix typos, use empty brackets for referrences

ad0c95c

Reference our guide for operator install

d32713c

ricardozanini reviewed Aug 2, 2023

View reviewed changes

...es/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc Outdated Show resolved Hide resolved

KOGITO-9455: Improve Testing your application section

b3a3984

Expplains basics fo accesing the project via REST using CURL.

MarianMacik reviewed Aug 7, 2023

View reviewed changes

domhanak and others added 2 commits August 7, 2023 13:46

KOGITO-9455: Fix typos, invalid page refs and improve text

e1b9a0e

Fix typo in serverlessworkflow/modules/ROOT/pages/getting-started/cre…

29b6955

…ate-your-first-workflow-service-with-kn-cli-and-vscode.adoc Co-authored-by: Marián Macik <[email protected]>

ricardozanini approved these changes Aug 14, 2023

View reviewed changes

domhanak removed the DO_NOT_MERGE 🙅 don't merge this PR label Aug 14, 2023

KOGITO-9455: Add guide to nav.adoc and index.adoc

c3e9de0

radtriste added the backport-1.43.x label Aug 16, 2023

ederign approved these changes Sep 1, 2023

View reviewed changes

MarianMacik approved these changes Sep 1, 2023

View reviewed changes

ricardozanini merged commit bc241c9 into apache:main Sep 1, 2023

github-actions bot mentioned this pull request Sep 1, 2023

[1.42.x] KOGITO-9455: Create the getting started guide to describe how to run … #474

Merged

5 tasks

github-actions bot mentioned this pull request Sep 1, 2023

[1.40.x-prod] KOGITO-9455: Create the getting started guide to describe how to run … #475

Merged

5 tasks

github-actions bot mentioned this pull request Sep 1, 2023

[1.41.x] KOGITO-9455: Create the getting started guide to describe how to run … #476

Merged

5 tasks

This was referenced Sep 1, 2023

[1.40.x] KOGITO-9455: Create the getting started guide to describe how to run … #477

Merged

[1.43.x] KOGITO-9455: Create the getting started guide to describe how to run … #478

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

KOGITO-9455: Create the getting started guide to describe how to run … #421

KOGITO-9455: Create the getting started guide to describe how to run … #421

domhanak commented Jul 31, 2023 •

edited

Loading

netlify bot commented Jul 31, 2023 •

edited

Loading

ricardozanini left a comment

kaldesai left a comment

domhanak commented Aug 2, 2023

domhanak commented Aug 2, 2023

ricardozanini commented Aug 30, 2023

KOGITO-9455: Create the getting started guide to describe how to run … #421

KOGITO-9455: Create the getting started guide to describe how to run … #421

Conversation

domhanak commented Jul 31, 2023 • edited Loading

netlify bot commented Jul 31, 2023 • edited Loading

✅ Deploy Preview for tangerine-crostata-04a6bf ready!

ricardozanini left a comment

Choose a reason for hiding this comment

kaldesai left a comment

Choose a reason for hiding this comment

domhanak commented Aug 2, 2023

domhanak commented Aug 2, 2023

ricardozanini commented Aug 30, 2023

domhanak commented Jul 31, 2023 •

edited

Loading

netlify bot commented Jul 31, 2023 •

edited

Loading