Initial setup page
βπΌNOTE: the page doesn't describe the installation process because it is the same as for all other apps. There is only information about setting up the Dashboard app
Contentsππ»
Adding resources
1. Select βAppsβ from the navigation bar on your Jira instance β Click on the βSmart Productivity Dashboardβ
βAdd resourcesβ is the very first step where we are configuring connections to the applications for which we are going to build productivity charts.
Add Confluence credentials to fetch confluence data
π‘HINT: We would recommend to create and use a separate Jira/Confluence account with read only access to Confluence spaces and Jira Projects for this purposes.
Login to Jira using the account with access to all neccecarry Projects and Spaces you would like to gather statistics for.
Create new API Token by following Atlassian documentation.
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
π‘HINT: Itβs also recommended to use a separate read only GitHub account with access to all necessary repositories.
Login to the GitHub account to be used for fetching data for the Productivity reports.
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.
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
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.
You should select one or more repositories in the Select Github repositories field
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.
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 (coming soon)
Create teams and add users to the teams
And the last step β click on βContinueβ button to see the Dashboard π₯³
βπΌNOTE: It might take some time for the Smart Productivity Dashboard to fetch data after the first setup of Github and other Integrations.
Components library DELETE BEFORE PUBLISHING! | |
---|---|
Read more details on KB components and regulation here β https://railsware.atlassian.net/wiki/pages/createpage.action?spaceKey=SC&title=KB%20Regulation | |
Info note | βπΌNOTE: info message |
Warning note | βπΌNOTE: warning message |
Hint | π‘HINT: hint message |
Permissions required | π€ JIRA PERMISSION REQUIRED: grant users [Permission] to [action] π€ APP PERMISSION REQUIRED: grant users [Permission] to [action] More about permissions here β Checklist & Templates Permissions |
Longread | Contents ππΌ |
Emojis | β π π₯³ ππΌ ππΌ β π π₯ β‘οΈ π€πΌ π π π π π’ π₯ π€ π« π©π½βπ» π§π»βπ» π βοΈ π π£ π π‘π π ππΌ |