Skip to content

Commit f8b1c0b

Browse files
Polish onboarding documentation (#739)
--------- Co-authored-by: Mathieu Leplatre <[email protected]>
1 parent 30a59b6 commit f8b1c0b

File tree

1 file changed

+26
-13
lines changed

1 file changed

+26
-13
lines changed

README.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,19 +43,32 @@ graph TD
4343

4444
### How to onboard a new project?
4545

46-
1. If you are an admin of the Jira project add the Jira Automation Bot. Go to Jira project and open
47-
`Project Settings` then `People`. Select `Add People` and search for `Jira Automation`. If two are listed select
48-
the one with the green logo. From the `Roles` drop down select `Bots`. Click `Add 1 person`.
49-
2. If you are not an admin of the Jira project contact the admin to determine how best to request the changes described
50-
in step 1.
51-
3. Add an entry for your whiteboard tag (eg. `famous-product`) in the [actions configuration files](config/).
52-
See [actions documentation](docs/actions.md).
53-
4. Open a pull-request with your action configuration changes. Indicate in the PR if the Jira Automation Bot has already been added to the Jira project.
54-
5. Once the PR is merged and a release is created, create a bug in bugzilla and add your whiteboard tag to the bug. Note
55-
that the tag must be enclosed in square brackets (eg. `[famous-project]`).
56-
6. If a Jira item already exists add it to the `See Also` section of the bug to begin syncing. If a Jira item does not
57-
already exist one will be created.
58-
7. Verify that the tag is listed in the Labels for the Jira item (eg. `[famous-project]`)
46+
1. Submit configuration for your project
47+
- If you're comfortable opening your own pull request, add an entry for your whiteboard tag (eg. `famous-product`) in the [actions configuration files](config/).
48+
See [actions documentation](docs/actions.md)
49+
- If not, submit an issue [here](https://github.com/mozilla/jira-bugzilla-integration/issues/new?assignees=&labels=configuration&projects=&template=new-config.yaml&title=Sync+%3CBugzilla+Product%3E+with+%3CJira+Project%3E), and we'll set up your configuration
50+
1. Grant permissions to the Jira Automation Bot
51+
52+
- If you are an admin of the Jira project
53+
54+
- go to your Jira project and open `Project Settings`, then `People`.
55+
- Select `Add People` and search for `Jira Automation`. If two are listed select the one with the green logo
56+
- From the `Roles` drop down select `Bots`. Click `Add 1 person`.
57+
- Add these permissions for the bot
58+
59+
```
60+
"ADD_COMMENTS",
61+
"CREATE_ISSUES",
62+
"DELETE_ISSUES",
63+
"EDIT_ISSUES"
64+
```
65+
66+
- If you are not an admin of the Jira project, contact the admin or reach out to `#jira-support` in Slack to determine how best to request the changes described above
67+
68+
1. Once your configuration is merged and a JBI release is deployed, create a bug in Bugzilla and add your whiteboard tag to the bug. Note that the tag must be enclosed in square brackets (eg. `[famous-project]`). You should see an issue appear in Jira
69+
- If you want to start syncing a bug to a Jira issue that already exists, add the issue's link to the `See Also` section of the Bugzilla bug before you add the whiteboard tag
70+
71+
1. Verify that the action you took on the bug was property reflected on the Jira issue (e.g. the description was updated or a comment was added)
5972
6073
# Development
6174

0 commit comments

Comments
 (0)