Initial setup

Contents👇🏻

Adding resources

1. Select “Apps“ from the navigation bar on your Jira instance → Click on the “Smart Productivity Dashboard“

Open

2. “Add resources“ is the very first step where we are configuring connections to the applications for which we are going to build productivity charts.

Open

Add Confluence credentials to fetch confluence data

1. Login to Jira using the account with access to all neccecarry Projects and Spaces you would like to gather statistics for.

2. Create new API Token by following Atlassian documentation.

3. Add Atlassian account email and related API token to the corresponding fields in the Connect Confluence section

Connect GitHub account to fetch information about developers performance

1. Login to the GitHub account to be used for fetching data for the Productivity reports.

2. Follow GitHub documentation on how to create a personal access tokens OR follow the steps below to generate Fine-grained personal access token:
   
   - Login to GitHub with the Account having access to required repositories → Settings → Developer Settings → Personal access tokens → Fine-grained personal access tokens → Generate new token
   - Specify all required options such as Token name and Expiration (pick any value)
   - Select desired option in the Repository access section
   - Select Read-only option for the following options:
   Contents - required to read repository contents, commits, branches etc.
   Metadata - required to search repositories, list collaborators and access repository metadata.
   Pool requests - to read PR’s related information.
   - Review the Token settings and click on Generate token button

3. Copy token value on the next screen.

4. Paste created value to the Github access token field on the Add resources step and click Continue button.

5. Congratulations 🥳 You’ve just finished the most difficult part of the setup so let’s move on!

Setting up GitHub repositories and developers accounts

1. If the first step was done correctly you will be enabled to see the list Repositories from GitHub AND the list of all Jira users of your Instance at the Mapping step.

2. You should select one or more repositories in the Select Github repositories field

3. And after that you should select Github account for each each Jira user you would like to see some coding statistic. Just start typing GitHub user name or account in the field next to the User name and select found item. This step is mandatory to start background process of importing data from Github.

4. Once you are done with mapping of Github account for all Jira users you can proceed to the next step to set up your teams. Don’t worry, you can always return to the settings page and modify settings at any time.

Setting up Teams

1. Go to the Teams step and click on the “Create new team” button

2. Fill in the Name of the team field and click on the Add team members option

3. Use search to find needed users or just select them from the list and click on Add to the team → click Confirm button when you are ready with this group. But you can return and modify group members at any time.

4. Review the group members and confirm group creation one the next screen

4. Add more groups if needed and proceed to the Productivity Dashboard by clicking on the Continue button.

5. If all settings were done correctly you should see something like this