Skip to content

Commit e58bb05

Browse files
Update configs names in sync with readme
Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>
1 parent 7b1c82f commit e58bb05

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ The automation app utilizes the [Probot](https://probot.github.io/) framework an
1919

2020
### Service
2121

22-
A **Service** is an instance of the app that manages and manipulates specific `Resources` while performing defined `Operations`.
22+
A **Service** is an instance of the app that manages and manipulates specific `Resource` while performing defined `Operation`.
2323
* **Resource**: Objects or entities the service will manage or modify, such as GitHub organizations, project, repositories, issues, etc.
24-
* **Operation**: A list of **Tasks** triggered by events with the resources.
25-
* **Task**: Executed sequentially within an **Operation** to perform action, such as create comments, update labels, add issue to project, etc.
24+
* **Operation**: A list of `Tasks` triggered by events with the resources.
25+
* **Task**: Executed sequentially within an `Operation` to perform action, such as create comments, update labels, add issue to project, etc.
2626
* **Call**: The callstack that contains the implementation of the aformentioned task action.
2727

2828
### Create a Service
@@ -44,9 +44,9 @@ RESOURCE_CONFIG=configs/resources/sample-resource.yml OPERATION_CONFIG=configs/o
4444
```
4545

4646
When you run the above command, the following takes place:
47-
1. The app starts a **Service** instance based on the specified configurations.
48-
1. Retrieves the **[GitHub Context](https://probot.github.io/api/latest/classes/context.Context.html)** (or any other defined context) for all the resources listed in the resource config file.
49-
1. Registers and listens for events, executes the **Tasks** defined in the operation config. These tasks will be executed sequentially when the corresponding events occur.
47+
1. The app starts a `Service` instance based on the specified configurations.
48+
1. Retrieves the [GitHub Context](https://probot.github.io/api/latest/classes/context.Context.html) (or any other defined context) for all the resources listed in the resource config file.
49+
1. Registers and listens for events, executes the `Tasks` defined in the operation config. These tasks will be executed sequentially when the corresponding events occur.
5050

5151
## Code of Conduct
5252

File renamed without changes.

0 commit comments

Comments
 (0)