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

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

Merged
merged 1 commit into from
Oct 5, 2023

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Sep 1, 2023

Backport: https://github.com/kiegroup/kogito-docs/pull/421

Note: CI is not automatically triggered on backported PRs, please comment 'ok to test' to launch Jenkins jobs

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

#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]>
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants