apache / apache/incubator-kie-examples

Update documentation for serverless-workflow-testing-with-rest-assured example

Open Beginner friendly
#1,968 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
300
Forks
449
Avg merge
2d 6h
Merged PRs (30d)
5

Description

### Description

Update documentation for [serverless-workflow-testing-with-rest-assured](https://github.com/apache/incubator-kie-kogito-examples/tree/stable/serverless-workflow-examples/serverless-workflow-testing-with-rest-assured) example.

#### Details
There is adoc reference in the readme file.
adoc file is not aimed to be used directly in the guidelines/readme file. It is just a source that may not be formatted properly.
In addition, the referenced guide is currently in kie repository instead of apache. See https://github.com/kiegroup/kogito-docs/blob/main/serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/basic-integration-tests-with-restassured.adoc

### Acceptance criteria
The readme file is updated as follows:
- The readme file should contain the guide that is readable and well formatted.
- The readme file format is one of the following:
- A text directly embedded to the readme file.
- The readme file can be referenced, but it must be accessible, and it is published in apache managed repository/sources.

### Implementation ideas

_No response_

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the README for the serverless-workflow-testing-with-rest-assured example and compare its current reference with the linked KIE documentation source. Update the README so the guide is readable and well formatted, either embedded directly or linked from an accessible Apache-managed source. Verify that the README meets each acceptance criterion.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.