Skip to content

Commit 1e0e6ce

Browse files
Apply suggestions from code review
Co-authored-by: Mathieu Leplatre <[email protected]>
1 parent 09c29c1 commit 1e0e6ce

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ System to sync Bugzilla bugs to Jira issues.
1111
- Bugs' whiteboard tags are used to determine if they should be synchronized or ignored
1212

1313
## Action Configuration
14-
The action configuration uses a YAML file per environment, this file stores all the configuration information for jbi data flows. The process to enable a new data flow will be explained below.
14+
The system reads the action configuration from a YAML file, one per environment. Each entry controls the synchronization between Bugzilla tickets with Jira issues.
1515

1616

17-
Below is an full example of an action configuration:
17+
Below is a full example of an action configuration:
1818
```yaml
1919
action: src.jbi.whiteboard_actions.default
2020
contact: [[email protected]]
@@ -29,10 +29,10 @@ A bit more about the different fields...
2929
- `action` (optional)
3030
- string
3131
- default: [src.jbi.whiteboard_actions.default](src/jbi/whiteboard_actions/default.py)
32-
- If using a custom action, place the PYTHONPATH to the custom action python module
32+
- The specified Python module must be available in the `PYTHONPATH`
3333
- `contact`
3434
- list of strings
35-
- If an issue arises with the workflow, communication will be established with this `contact`
35+
- If an issue arises with the workflow, communication will be established with these contacts
3636
- Please enter the contact information for one or more stakeholders
3737
- `description`
3838
- string
@@ -44,7 +44,7 @@ A bit more about the different fields...
4444
- `parameters` (optional)
4545
- dict
4646
- default: {}
47-
- The parameters will be validated to ensure the selected action has all expected parameters
47+
- The parameters will be validated to ensure the selected action accepts the specified values
4848
- The [default action](src/jbi/whiteboard_actions/default.py) expects both the `whiteboard_tag` and `jira_project_key` fields
4949

5050

0 commit comments

Comments
 (0)