Skip to content

Commit 7c31eb2

Browse files
authored
docs(bitbucket): copy all documentation images locally (#809)
1 parent a74cf5d commit 7c31eb2

8 files changed

+15
-13
lines changed

docs/Configuration/BitBucket.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ API tokens are the recommended authentication method for Bitbucket Cloud. Learn
4343
2. Select **Create API token with scopes**.
4444
3. Give the API token a name and an expiry date (ex: 365 days), then select **Next**.
4545
4. Select **Bitbucket** as the app and select **Next**.
46-
5. Select the required scopes (see **Q2**) and select **Next**.
46+
5. Select the required scopes (see below) and select **Next**.
4747
6. Review your token and select **Create token**.
4848
7. **Copy the generated API token immediately** - it's only displayed once and can't be retrieved later.
4949

@@ -63,7 +63,7 @@ The following scopes are **required** to collect data from Bitbucket repositorie
6363
- `read:user:bitbucket` - View user info (required for connection test)
6464
- `read:workspace:bitbucket` - View your workspaces
6565

66-
![Bitbucket API token scopes selection interface](/img/ConfigUI/bitbucket-api-token-scope-selection-interface.png)
66+
![Bitbucket API Token Scopes Selection Interface](/img/ConfigUI/bitbucket-api-token-scope-selection-interface.png)
6767

6868
##### App Password (Deprecated)
6969

@@ -73,6 +73,8 @@ App passwords are deprecated and should only be used for existing connections. F
7373

7474
If you're using an existing App password, learn about [how to create a Bitbucket app password](https://support.atlassian.com/bitbucket-cloud/docs/create-an-app-password/).
7575

76+
**Required Permissions:**
77+
7678
- Account:Read
7779
- Workspace membership:Read
7880
- Projects:Read
@@ -82,7 +84,7 @@ If you're using an existing App password, learn about [how to create a Bitbucket
8284
- Pipelines:Read
8385
- Runners:Read
8486

85-
![bitbucket-app-password-permissions](/img/ConfigUI/bitbucket-app-password-permissions.jpeg)
87+
![Bitbucket App Password Permissions](/img/ConfigUI/bitbucket-app-password-permissions.jpeg)
8688

8789
#### Proxy URL (Optional)
8890

@@ -117,7 +119,7 @@ Your data collection will continue without interruption, and you'll be ready for
117119

118120
Choose the Bitbucket repositories you wish to collect either by finding them in the miller column, or searching. You can only add public repositories through the search box.
119121

120-
![image](https://user-images.githubusercontent.com/14050754/224308925-449a4d3e-ed52-45e9-bb72-0d2892df374f.png)
122+
![Bitbucket - Add Data Scopes](/img/ConfigUI/bitbucket-add-data-scopes.png)
121123

122124
### Step 1.3 - Add Scope Config (Optional)
123125

@@ -144,7 +146,7 @@ The transformations on the Bitbucket data you are going to collect.
144146

145147
###### Issue Tracking > Issue Status Mapping
146148

147-
![image](https://user-images.githubusercontent.com/14050754/224309704-b096c256-b2cf-4107-b78c-044d06b5f23c.png)
149+
![Bitbucket Issue Status Mapping](/img/ConfigUI/bitbucket-issue-status-mapping.png)
148150

149151
The given settings transformed the Bitbucket issue statuses to the issue statuses used by DevLake, enabling you to measure metrics like the Issue Delivery Rate on the pre-built dashboards, as DevLake understands your definition of when an issue is considered as completed (status = 'DONE').
150152

@@ -165,18 +167,18 @@ The CI/CD configuration for Bitbucket is used for calculating [DORA metrics](../
165167

166168
By default, DevLake will identify the deployment and environment settings that are defined in the Bitbucket CI .yml file.
167169

168-
![image](https://user-images.githubusercontent.com/14050754/224311429-31304867-8cdd-476b-8675-e4acbc17f552.png)
170+
![Bitbucket Detect Deployments for DORA](/img/ConfigUI/bitbucket-detect-deployments-dora.png)
169171

170172
However, to ensure this works properly, you must specify the deployment settings in the .yml file.
171-
![img_v2_89602d14-a733-4679-9d4b-d9635c03bc5g](https://user-images.githubusercontent.com/3294100/221528908-4943b1e6-1398-49e9-8ce9-aa264995f9bc.jpg)
173+
![Bitbucket Pipelines Deployment Settings](/img/ConfigUI/bitbucket-pipelines-deployment-settings.png)
172174

173175
The pipeline steps with the `deployment` key will be recognized as DevLake deployments. The value of the `deployment` key will be recognized as the environment of DevLake deployments.
174176

175177
All Bitbucket pipeline steps will be saved in table 'cicd_tasks', but DevLake deployments will be set as `type` = 'deployment' and `environment` = '{Bitbucket-pipeline-step.deployment.value}'.
176178

177179
If you have not defined these settings in the .yml file, please select 'Detect Deployments from Pipeline steps in Bitbucket', and input the RegEx in the following fields:
178180

179-
![image](https://user-images.githubusercontent.com/14050754/224310350-cc9a4901-476d-4583-ad73-4d3b394bc343.png)
181+
![Bitbucket Detect Deployments Regex](/img/ConfigUI/bitbucket-detect-deployments-regex.png)
180182

181183
- Deployment: A pipeline step with a name that matches the given RegEx will be recognized as a DevLake deployment.
182184
- Production: A pipeline step with a name that matches the given RegEx will be recognized as a DevLake cicd_task in the production environment.
@@ -186,11 +188,11 @@ If you have not defined these settings in the .yml file, please select 'Detect D
186188
Bitbucket has several key CI entities: `pipelines`, `pipeline steps`, and `deployments`. A Bitbucket pipeline contains several pipeline steps. Each pipeline step defined with a deployment key can be mapped to a Bitbucket deployment.
187189

188190
Each Bitbucket pipeline is converted to a cicd_pipeline in DevLake's domain layer schema and each Bitbucket pipeline step is converted to a cicd_task in DevLake's domain layer.
189-
![image](https://user-images.githubusercontent.com/3294100/220288225-71bee07d-c319-45bd-98e5-f4d01359840e.png)
191+
![Bitbucket Pipeline interface showing CI entities and DevLake schema mapping](/img/ConfigUI/bitbucket-ci-entities-overview.png)
190192

191193
If a pipeline step defines `deployment` with a value (usually indicating the environment), this pipeline step is also a Bitbucket deployment.
192194

193-
![image](https://user-images.githubusercontent.com/3294100/221887426-4cae1c46-31ce-4fcd-b773-a54c28af0264.png)
195+
![Bitbucket Deployment view showing environment history with various pipeline runs](/img/ConfigUI/bitbucket-deployment-pipeline-history.png)
194196

195197
###### Additional Settings (Optional)
196198

@@ -211,14 +213,14 @@ Please click `Save` to save the transformation rules for the repo. In the data s
211213

212214
Collecting Bitbucket data requires creating a project first. You can visit the Project page from the side menu and create a new project by following the instructions on the user interface.
213215

214-
![create-a-project](images/create-a-project.png)
216+
![DevLake Project Creation Interface](images/create-a-project.png)
215217

216218
### Step 2.2 - Add a Bitbucket Connection
217219

218220
You can add a previously configured Bitbucket connection to the project and select the boards for which you wish to collect the data for.
219221
Please note: if you don't see the repositories you are looking for, please check if you have added them to the connection first.
220222

221-
![add-a-connection](images/add-a-connection-project.png)
223+
![DevLake Project Add Connection Interface](images/add-a-connection-project.png)
222224

223225
### Step 2.3 - Set the Sync Policy
224226

@@ -228,7 +230,7 @@ There are three settings for Sync Policy:
228230
- Sync Frequency: You can choose how often you would like to sync your data in this step by selecting a sync frequency option or enter a cron code to specify your preferred schedule.
229231
- Skip Failed Tasks: sometime a few tasks may fail in a long pipeline; you can choose to skip them to avoid spending more time in running the pipeline all over again.
230232

231-
![sync-policy](images/sync-policy.png)
233+
![DevLake Sync Policy Settings](images/sync-policy.png)
232234

233235
### Step 2.4 - Start Data Collection
234236

53.4 KB
Loading
231 KB
Loading
311 KB
Loading
23.7 KB
Loading
35.8 KB
Loading
16.4 KB
Loading
254 KB
Loading

0 commit comments

Comments
 (0)