Skip to content

Commit 8e2666b

Browse files
committed
Merge branch 'docs-image-alignment' into 'master'
Fix markdown spacing in various docs (part 3) See merge request gitlab-org/gitlab-ce!31709
2 parents 74efd58 + f751748 commit 8e2666b

File tree

14 files changed

+108
-103
lines changed

14 files changed

+108
-103
lines changed

doc/administration/auditor_users.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ section.
5252
**Admin Area > Users**. You will find the option of the access level under
5353
the 'Access' section.
5454

55-
![Admin Area Form](img/auditor_access_form.png)
55+
![Admin Area Form](img/auditor_access_form.png)
5656

5757
1. Click **Save changes** or **Create user** for the changes to take effect.
5858

doc/ci/caching/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -378,8 +378,8 @@ Here's what happens behind the scenes:
378378
1. `script` is executed.
379379
1. `after_script` is executed.
380380
1. `cache` runs and the `vendor/` directory is zipped into `cache.zip`.
381-
This file is then saved in the directory based on the
382-
[Runner's setting](#where-the-caches-are-stored) and the `cache: key`.
381+
This file is then saved in the directory based on the
382+
[Runner's setting](#where-the-caches-are-stored) and the `cache: key`.
383383
1. `job B` runs.
384384
1. The cache is extracted (if found).
385385
1. `before_script` is executed.
@@ -520,7 +520,7 @@ via GitLab's UI:
520520
1. Navigate to your project's **CI/CD > Pipelines** page.
521521
1. Click on the **Clear Runner caches** button to clean up the cache.
522522

523-
![Clear Runners cache](img/clear_runners_cache.png)
523+
![Clear Runners cache](img/clear_runners_cache.png)
524524

525525
1. On the next push, your CI/CD job will use a new cache.
526526

doc/ci/ci_cd_for_external_repos/bitbucket_integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ To use GitLab CI/CD with a Bitbucket Cloud repository:
4444
Passwords** to authenticate the build status script setting commit build
4545
statuses in Bitbucket. Repository write permissions are required.
4646

47-
![Bitbucket Cloud webhook](img/bitbucket_app_password.png)
47+
![Bitbucket Cloud webhook](img/bitbucket_app_password.png)
4848

4949
1. In GitLab, from **Settings > CI/CD > Environment variables**, add variables to allow
5050
communication with Bitbucket via the Bitbucket API:

doc/ci/ci_cd_for_external_repos/github_integration.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ administrator:
1919
1. In GitLab create a **CI/CD for external repo** project and select
2020
**GitHub**.
2121

22-
![Create project](img/github_omniauth.png)
22+
![Create project](img/github_omniauth.png)
2323

2424
1. Once authenticated, you will be redirected to a list of your repositories to
2525
connect. Click **Connect** to select the repository.
2626

27-
![Create project](img/github_repo_list.png)
27+
![Create project](img/github_repo_list.png)
2828

2929
1. In GitHub, add a `.gitlab-ci.yml` to [configure GitLab CI/CD](../quick_start/README.md).
3030

@@ -55,14 +55,14 @@ repositories:
5555
Token**. This token with be used to access your repository and push commit
5656
statuses to GitHub.
5757

58-
The `repo` and `admin:repo_hook` should be enable to allow GitLab access to
59-
your project, update commit statuses, and create a web hook to notify
60-
GitLab of new commits.
58+
The `repo` and `admin:repo_hook` should be enable to allow GitLab access to
59+
your project, update commit statuses, and create a web hook to notify
60+
GitLab of new commits.
6161

6262
1. In GitLab create a **CI/CD for external repo** project and select
6363
**GitHub**.
6464

65-
![Create project](img/github_omniauth.png)
65+
![Create project](img/github_omniauth.png)
6666

6767
1. Paste the token into the **Personal access token** field and click **List
6868
Repositories**. Click **Connect** to select the repository.
@@ -86,37 +86,37 @@ your repository:
8686
Access Token.** GitLab will use this token to access your repository and
8787
push commit statuses.
8888

89-
Enter a **Token description** and update the scope to allow:
89+
Enter a **Token description** and update the scope to allow:
9090

91-
`repo` so that GitLab can access your project and update commit statuses
91+
`repo` so that GitLab can access your project and update commit statuses
9292

9393
1. In GitLab create a **CI/CD project** using the Git URL option and the HTTPS
9494
URL for your GitHub repository. If your project is private, use the personal
9595
access token you just created for authentication.
9696

97-
GitLab will automatically configure polling-based pull mirroring.
97+
GitLab will automatically configure polling-based pull mirroring.
9898

9999
1. Still in GitLab, enable the [GitHub project integration](../../user/project/integrations/github.md)
100100
from **Settings > Integrations.**
101101

102-
Check the **Active** checkbox to enable the integration, paste your
103-
personal access token and HTTPS repository URL into the form, and **Save.**
102+
Check the **Active** checkbox to enable the integration, paste your
103+
personal access token and HTTPS repository URL into the form, and **Save.**
104104

105105
1. Still in GitLab create a **Personal Access Token** with `API` scope to
106106
authenticate the GitHub web hook notifying GitLab of new commits.
107107

108108
1. In GitHub from **Settings > Webhooks** create a web hook to notify GitLab of
109109
new commits.
110110

111-
The web hook URL should be set to the GitLab API to
112-
[trigger pull mirroring](../../api/projects.md#start-the-pull-mirroring-process-for-a-project-starter),
113-
using the GitLab personal access token we just created.
111+
The web hook URL should be set to the GitLab API to
112+
[trigger pull mirroring](../../api/projects.md#start-the-pull-mirroring-process-for-a-project-starter),
113+
using the GitLab personal access token we just created.
114114

115-
```
116-
https://gitlab.com/api/v4/projects/<NAMESPACE>%2F<PROJECT>/mirror/pull?private_token=<PERSONAL_ACCESS_TOKEN>
117-
```
115+
```
116+
https://gitlab.com/api/v4/projects/<NAMESPACE>%2F<PROJECT>/mirror/pull?private_token=<PERSONAL_ACCESS_TOKEN>
117+
```
118118

119-
![Create web hook](img/github_push_webhook.png)
119+
![Create web hook](img/github_push_webhook.png)
120120

121121
1. In GitHub add a `.gitlab-ci.yml` to configure GitLab CI/CD.
122122

doc/ci/examples/devops_and_game_dev_with_gitlab_ci_cd/index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -418,10 +418,14 @@ fully understand [IAM Best Practices in AWS](https://docs.aws.amazon.com/IAM/lat
418418

419419
1. Log into your AWS account and go to the [Security Credentials page](https://console.aws.amazon.com/iam/home#/security_credential)
420420
1. Click the **Access Keys** section and **Create New Access Key**. Create the key and keep the id and secret around, you'll need them later
421-
![AWS Access Key Config](img/aws_config_window.png)
421+
422+
![AWS Access Key Config](img/aws_config_window.png)
423+
422424
1. Go to your GitLab project, click **Settings > CI/CD** on the left sidebar
423425
1. Expand the **Variables** section
424-
![GitLab Secret Config](img/gitlab_config.png)
426+
427+
![GitLab Secret Config](img/gitlab_config.png)
428+
425429
1. Add a key named `AWS_KEY_ID` and copy the key id from Step 2 into the **Value** textbox
426430
1. Add a key named `AWS_KEY_SECRET` and copy the key secret from Step 2 into the **Value** textbox
427431

doc/ci/review_apps/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,11 +147,11 @@ Once you have the route mapping set up, it will take effect in the following loc
147147

148148
- In the diff for a merge request, comparison, or commit.
149149

150-
!["View on env" button in merge request diff](img/view_on_env_mr.png)
150+
!["View on env" button in merge request diff](img/view_on_env_mr.png)
151151

152152
- In the blob file view.
153153

154-
!["View on env" button in file view](img/view_on_env_blob.png)
154+
!["View on env" button in file view](img/view_on_env_blob.png)
155155

156156
## Visual Reviews **(STARTER)**
157157

doc/ci/runners/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ You can only register a shared Runner if you are an admin of the GitLab instance
6262

6363
1. Grab the shared-Runner token on the `admin/runners` page
6464

65-
![Shared Runners admin area](img/shared_runners_admin.png)
65+
![Shared Runners admin area](img/shared_runners_admin.png)
6666

6767
1. [Register the Runner][register]
6868

@@ -373,12 +373,12 @@ attacker.
373373

374374
To reset the token:
375375

376-
1. Go to **Settings > CI/CD** for a specified Project
377-
1. Expand the **General pipelines settings** section
378-
1. Find the **Runner token** form field and click the **Reveal value** button
379-
1. Delete the value and save the form
376+
1. Go to **Settings > CI/CD** for a specified Project.
377+
1. Expand the **General pipelines settings** section.
378+
1. Find the **Runner token** form field and click the **Reveal value** button.
379+
1. Delete the value and save the form.
380380
1. After the page is refreshed, expand the **Runners settings** section
381-
and check the registration token - it should be changed
381+
and check the registration token - it should be changed.
382382

383383
From now on the old token is not valid anymore and will not allow to register
384384
a new Runner to the project. If you are using any tools to provision and

doc/integration/facebook.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To enable the Facebook OmniAuth provider you must register your application with
1919

2020
1. Enter the address of your GitLab installation at the bottom of the package
2121

22-
![Facebook Website URL](img/facebook_website_url.png)
22+
![Facebook Website URL](img/facebook_website_url.png)
2323

2424
1. Choose "Next"
2525

@@ -29,7 +29,7 @@ To enable the Facebook OmniAuth provider you must register your application with
2929

3030
1. Fill in a contact email for your app
3131

32-
![Facebook App Settings](img/facebook_app_settings.png)
32+
![Facebook App Settings](img/facebook_app_settings.png)
3333

3434
1. Choose "Save Changes"
3535

@@ -45,7 +45,7 @@ To enable the Facebook OmniAuth provider you must register your application with
4545

4646
1. You should now see an app key and app secret (see screenshot). Keep this page open as you continue configuration.
4747

48-
![Facebook API Keys](img/facebook_api_keys.png)
48+
![Facebook API Keys](img/facebook_api_keys.png)
4949

5050
1. On your GitLab server, open the configuration file.
5151

doc/integration/jira_development_panel.md

Lines changed: 37 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -43,67 +43,68 @@ There are no special requirements if you are using GitLab.com.
4343

4444
1. In GitLab, create a new application in order to allow Jira to connect with your GitLab account
4545

46-
While logged-in, go to `Settings -> Applications`. (Click your profile avatar at
47-
the top right, choose `Settings`, and then navigate to `Applications` from the left
48-
navigation menu.) Use the form to create a new application.
46+
While logged-in, go to `Settings -> Applications`. (Click your profile avatar at
47+
the top right, choose `Settings`, and then navigate to `Applications` from the left
48+
navigation menu.) Use the form to create a new application.
4949

50-
Enter a useful name for the `Name` field.
50+
Enter a useful name for the `Name` field.
5151

52-
For the `Redirect URI` field, enter `https://<your-gitlab-instance-domain>/login/oauth/callback`,
53-
replacing `<your-gitlab-instance-domain>` appropriately. So for example, if you are using GitLab.com,
54-
this would be `https://gitlab.com/login/oauth/callback`.
52+
For the `Redirect URI` field, enter `https://<your-gitlab-instance-domain>/login/oauth/callback`,
53+
replacing `<your-gitlab-instance-domain>` appropriately. So for example, if you are using GitLab.com,
54+
this would be `https://gitlab.com/login/oauth/callback`.
5555

56-
NOTE: **Note**:
57-
If using a GitLab version earlier than 11.3 the `Redirect URI` value should be `https://<your-gitlab-instance-domain>/-/jira/login/oauth/callback`.
56+
NOTE: **Note**:
57+
If using a GitLab version earlier than 11.3 the `Redirect URI` value should be `https://<your-gitlab-instance-domain>/-/jira/login/oauth/callback`.
5858

59-
![GitLab Application setup](img/jira_dev_panel_gl_setup_1.png)
60-
- Check `api` in the Scopes section.
59+
![GitLab Application setup](img/jira_dev_panel_gl_setup_1.png)
60+
61+
- Check `api` in the Scopes section.
6162

6263
1. Click `Save application`. You will see the generated 'Application Id' and 'Secret' values.
63-
Copy these values that you will use on the Jira configuration side.
64+
Copy these values that you will use on the Jira configuration side.
6465

6566
## Jira Configuration
6667

6768
1. In Jira, from the gear menu at the top right, go to `Applications`. Navigate to `DVCS accounts`
68-
from the left navigation menu. Click `Link GitHub account` to start creating a new integration.
69-
(We are pretending to be GitHub in this integration until there is further platform support from Jira.)
69+
from the left navigation menu. Click `Link GitHub account` to start creating a new integration.
70+
(We are pretending to be GitHub in this integration until there is further platform support from Jira.)
7071

71-
![Jira DVCS from Dashboard](img/jira_dev_panel_jira_setup_1.png)
72+
![Jira DVCS from Dashboard](img/jira_dev_panel_jira_setup_1.png)
7273

7374
1. Complete the form
7475

75-
Select GitHub Enterprise for the `Host` field.
76+
Select GitHub Enterprise for the `Host` field.
7677

77-
For the `Team or User Account` field, enter the relative path of a top-level GitLab group that you have access to,
78-
or the relative path of your personal namespace.
78+
For the `Team or User Account` field, enter the relative path of a top-level GitLab group that you have access to,
79+
or the relative path of your personal namespace.
7980

80-
![Creation of Jira DVCS integration](img/jira_dev_panel_jira_setup_2.png)
81+
![Creation of Jira DVCS integration](img/jira_dev_panel_jira_setup_2.png)
8182

82-
For the `Host URL` field, enter `https://<your-gitlab-instance-domain>/`,
83-
replacing `<your-gitlab-instance-domain>` appropriately. So for example, if you are using GitLab.com,
84-
this would be `https://gitlab.com/`.
83+
For the `Host URL` field, enter `https://<your-gitlab-instance-domain>/`,
84+
replacing `<your-gitlab-instance-domain>` appropriately. So for example, if you are using GitLab.com,
85+
this would be `https://gitlab.com/`.
8586

86-
NOTE: **Note**:
87-
If using a GitLab version earlier than 11.3 the `Host URL` value should be `https://<your-gitlab-instance-domain>/-/jira`
87+
NOTE: **Note**:
88+
If using a GitLab version earlier than 11.3 the `Host URL` value should be `https://<your-gitlab-instance-domain>/-/jira`
8889

89-
For the `Client ID` field, use the `Application ID` value from the previous section.
90+
For the `Client ID` field, use the `Application ID` value from the previous section.
9091

91-
For the `Client Secret` field, use the `Secret` value from the previous section.
92+
For the `Client Secret` field, use the `Secret` value from the previous section.
9293

93-
Ensure that the rest of the checkboxes are checked.
94+
Ensure that the rest of the checkboxes are checked.
9495

9596
1. Click `Add` to complete and create the integration.
9697

97-
Jira takes up to a few minutes to know about (import behind the scenes) all the commits and branches
98-
for all the projects in the GitLab group you specified in the previous step. These are refreshed
99-
every 60 minutes.
98+
Jira takes up to a few minutes to know about (import behind the scenes) all the commits and branches
99+
for all the projects in the GitLab group you specified in the previous step. These are refreshed
100+
every 60 minutes.
100101

101-
> **Note:**
102-
> In the future, we plan on implementating real-time integration. If you need
103-
> to refresh the data manually, you can do this from the `Applications -> DVCS
104-
> accounts` screen where you initially set up the integration:
105-
>
106-
> ![Refresh GitLab information in Jira](img/jira_dev_panel_manual_refresh.png)
102+
> **Note:**
103+
> In the future, we plan on implementating real-time integration. If you need
104+
> to refresh the data manually, you can do this from the `Applications -> DVCS
105+
> accounts` screen where you initially set up the integration:
106+
>
107+
> ![Refresh GitLab information in Jira](img/jira_dev_panel_manual_refresh.png)
107108
108109
To connect additional GitLab projects from other GitLab top-level groups (or personal namespaces), repeat the above
109110
steps with additional Jira DVCS accounts.

doc/tools/email.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ at their primary email address.
1919
1. Go to the admin area using the wrench icon in the top right corner and
2020
navigate to **Overview > Users > Send email to users**.
2121

22-
![admin users](email1.png)
22+
![admin users](email1.png)
2323

2424
1. Compose an email and choose where it will be sent (all users or users of a
2525
chosen group or project):
2626

27-
![compose an email](email2.png)
27+
![compose an email](email2.png)
2828

2929
## Unsubscribing from emails
3030

0 commit comments

Comments
 (0)