kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Merge branch 'docs-image-alignment-2' into 'master'

Browse source 
Fix markdown spacing in various docs (part 4)

See merge request gitlab-org/gitlab-ce!31710
This commit is contained in:
Achilleas Pipinellis 2019-08-12 09:54:31 +00:00
commit 95075fee78
16 changed files with 119 additions and 125 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
doc/user/group/index.md
View file

@ -91,11 +91,11 @@ To create a new Group, either:
- In the top menu, click **Groups** and then **Your Groups**, and click the green button **New group**. - In the top menu, click **Groups** and then **Your Groups**, and click the green button **New group**.
![new group from groups page](img/new_group_from_groups.png) ![new group from groups page](img/new_group_from_groups.png)
- Or, in the top menu, expand the `plus` sign and choose **New group**. - Or, in the top menu, expand the `plus` sign and choose **New group**.
![new group from elsewhere](img/new_group_from_other_pages.png) ![new group from elsewhere](img/new_group_from_other_pages.png)
Add the following information: Add the following information:
@ -104,15 +104,15 @@ Add the following information:
1. The **Group name** will automatically populate the URL. Optionally, you can change it. 1. The **Group name** will automatically populate the URL. Optionally, you can change it.
This is the name that displays in group views. This is the name that displays in group views.
The name can contain only: The name can contain only:
- Alphanumeric characters - Alphanumeric characters
- Underscores - Underscores
- Dashes and dots - Dashes and dots
- Spaces - Spaces
1. The **Group URL** is the namespace under which your projects will be hosted. 1. The **Group URL** is the namespace under which your projects will be hosted.
The URL can contain only: The URL can contain only:
- Alphanumeric characters - Alphanumeric characters
- Underscores - Underscores
- Dashes and dots (it cannot start with dashes or end in a dot) - Dashes and dots (it cannot start with dashes or end in a dot)
1. Optionally, you can add a brief description to tell others 1. Optionally, you can add a brief description to tell others
what this group is about. what this group is about.
1. Optionally, choose an avatar for your group. 1. Optionally, choose an avatar for your group.
@ -166,12 +166,12 @@ There are two different ways to add a new project to a group:
- Select a group, and then click **New project**. You can then continue [creating your project](../../gitlab-basics/create-project.md). - Select a group, and then click **New project**. You can then continue [creating your project](../../gitlab-basics/create-project.md).
![New project](img/create_new_project_from_group.png) ![New project](img/create_new_project_from_group.png)
- While you are creating a project, select a group namespace - While you are creating a project, select a group namespace
you've already created from the dropdown menu. you've already created from the dropdown menu.
![Select group](img/select_group_dropdown.png) ![Select group](img/select_group_dropdown.png)
### Default project-creation level ### Default project-creation level

6
doc/user/group/saml_sso/scim_setup.md
View file

@ -90,11 +90,11 @@ You can then test the connection by clicking on **Test Connection**. If the conn
1. Create a new mapping by clicking **Add New Mapping** then set **Source attribute** to `objectId`, and **Target attribute** to `externalId`. 1. Create a new mapping by clicking **Add New Mapping** then set **Source attribute** to `objectId`, and **Target attribute** to `externalId`.
1. Click the `userPrincipalName` mapping and change **Match objects using this attribute** to `No`. 1. Click the `userPrincipalName` mapping and change **Match objects using this attribute** to `No`.
Save your changes and you should have the following configuration: Save your changes and you should have the following configuration:
![Azure's attribute mapping configuration](img/scim_attribute_mapping.png) ![Azure's attribute mapping configuration](img/scim_attribute_mapping.png)
NOTE: **Note:** If you used a unique identifier **other than** `objectId`, be sure to map it instead to both `id` and `externalId`. NOTE: **Note:** If you used a unique identifier **other than** `objectId`, be sure to map it instead to both `id` and `externalId`.
1. Below the mapping list click on **Show advanced options > Edit attribute list for AppName**. 1. Below the mapping list click on **Show advanced options > Edit attribute list for AppName**.
1. Leave the `id` as the primary and only required field. 1. Leave the `id` as the primary and only required field.
@ -108,7 +108,7 @@ You can then test the connection by clicking on **Test Connection**. If the conn
1. Save all the screens and, in the **Provisioning** step, set 1. Save all the screens and, in the **Provisioning** step, set
the `Provisioning Status` to `On`. the `Provisioning Status` to `On`.
![Provisioning status toggle switch](img/scim_provisioning_status.png) ![Provisioning status toggle switch](img/scim_provisioning_status.png)
NOTE: **Note:** NOTE: **Note:**
You can control what is actually synced by selecting the `Scope`. For example, You can control what is actually synced by selecting the `Scope`. For example,

2
doc/user/project/file_lock.md
View file

@ -40,7 +40,7 @@ To lock a file:
1. Pick the file you want to lock. 1. Pick the file you want to lock.
1. Click the "Lock" button. 1. Click the "Lock" button.
![Locking file](img/file_lock.png) ![Locking file](img/file_lock.png)
To lock an entire directory, look for the "Lock" link next to "History". To lock an entire directory, look for the "Lock" link next to "History".

6
doc/user/project/import/bitbucket.md
View file

@ -49,17 +49,17 @@ namespace that started the import process.
1. Click on the "Bitbucket Cloud" button. 1. Click on the "Bitbucket Cloud" button.
![Bitbucket](img/import_projects_from_new_project_page.png) ![Bitbucket](img/import_projects_from_new_project_page.png)
1. Grant GitLab access to your Bitbucket account 1. Grant GitLab access to your Bitbucket account
![Grant access](img/bitbucket_import_grant_access.png) ![Grant access](img/bitbucket_import_grant_access.png)
1. Click on the projects that you'd like to import or **Import all projects**. 1. Click on the projects that you'd like to import or **Import all projects**.
You can also select the namespace under which each project will be You can also select the namespace under which each project will be
imported. imported.
![Import projects](img/bitbucket_import_select_project.png) ![Import projects](img/bitbucket_import_select_project.png)
[bb-import]: ../../../integration/bitbucket.md [bb-import]: ../../../integration/bitbucket.md
[social sign-in]: ../../profile/account/social_sign_in.md [social sign-in]: ../../profile/account/social_sign_in.md

8
doc/user/project/import/bitbucket_server.md
View file

@ -59,16 +59,16 @@ namespace that started the import process.
1. Sign in to GitLab and go to your dashboard. 1. Sign in to GitLab and go to your dashboard.
1. Click on **New project**. 1. Click on **New project**.
1. Click on the "Bitbucket Server" button. If the button is not present, enable the importer in 1. Click on the "Bitbucket Server" button. If the button is not present, enable the importer in
**Admin > Application Settings > Visibility and access controls > Import sources**. **Admin > Application Settings > Visibility and access controls > Import sources**.
![Bitbucket](img/import_projects_from_new_project_page.png) ![Bitbucket](img/import_projects_from_new_project_page.png)
1. Enter your Bitbucket Server credentials. 1. Enter your Bitbucket Server credentials.
![Grant access](img/bitbucket_server_import_credentials.png) ![Grant access](img/bitbucket_server_import_credentials.png)
1. Click on the projects that you'd like to import or **Import all projects**. 1. Click on the projects that you'd like to import or **Import all projects**.
You can also select the namespace under which each project will be You can also select the namespace under which each project will be
imported. imported.
![Import projects](img/bitbucket_server_import_select_project.png) ![Import projects](img/bitbucket_server_import_select_project.png)

42
doc/user/project/import/gemnasium.md
View file

@ -5,13 +5,17 @@ instance or GitLab.com.
## Why is Gemnasium.com closed? ## Why is Gemnasium.com closed?
Gemnasium has been [acquired by GitLab](https://about.gitlab.com/press/releases/2018-01-30-gemnasium-acquisition.html) Gemnasium was [acquired by GitLab](https://about.gitlab.com/press/releases/2018-01-30-gemnasium-acquisition.html)
in January 2018. Since May 15, 2018, the services provided by Gemnasium are no longer available. in January 2018. Since May 15, 2018, the services provided by Gemnasium are no longer available.
The team behind Gemnasium has joined GitLab as the new Security Products team The team behind Gemnasium has joined GitLab as the new Security Products team
and is working on a wider range of tools than just Dependency Scanning: and is working on a [wide range of tools](../../application_security/index.md),
[SAST](../../application_security/sast/index.md), including:
[DAST](../../application_security/dast/index.md),
[Container Scanning](../../application_security/container_scanning/index.md) and more. - [Dependency Scanning](../../application_security/dependency_scanning/index.md)
- [SAST](../../application_security/sast/index.md)
- [DAST](../../application_security/dast/index.md)
- [Container Scanning](../../application_security/container_scanning/index.md)
If you want to continue monitoring your dependencies, see the If you want to continue monitoring your dependencies, see the
[Migrating to GitLab](#migrating-to-gitlab) section below. [Migrating to GitLab](#migrating-to-gitlab) section below.
@ -57,27 +61,27 @@ back to both GitLab and GitHub when completed.
1. Create a new project, and select the "CI/CD for external repo" tab: 1. Create a new project, and select the "CI/CD for external repo" tab:
![Create new Project](img/gemnasium/create_project.png) ![Create new Project](img/gemnasium/create_project.png)
1. Use the "GitHub" button to connect your repositories. 1. Use the "GitHub" button to connect your repositories.
![Connect from GitHub](img/gemnasium/connect_github.png) ![Connect from GitHub](img/gemnasium/connect_github.png)
1. Select the project(s) to be set up with GitLab CI/CD and chose "Connect". 1. Select the project(s) to be set up with GitLab CI/CD and chose "Connect".
![Select projects](img/gemnasium/select_project.png) ![Select projects](img/gemnasium/select_project.png)
Once the configuration is done, you may click on your new Once the configuration is done, you may click on your new
project on GitLab. project on GitLab.
![click on connected project](img/gemnasium/project_connected.png) ![click on connected project](img/gemnasium/project_connected.png)
Your project is now mirrored on GitLab, where the Runners will be able to access Your project is now mirrored on GitLab, where the Runners will be able to access
your source code and run your tests. your source code and run your tests.
Optional step: If you set this up on GitLab.com, make sure the project is Optional step: If you set this up on GitLab.com, make sure the project is
public (in the project settings) if your GitHub project is public, since public (in the project settings) if your GitHub project is public, since
the security feature is available only for [GitLab Ultimate](https://about.gitlab.com/pricing). the security feature is available only for [GitLab Ultimate](https://about.gitlab.com/pricing).
1. To set up the dependency scanning job, corresponding to what Gemnasium was 1. To set up the dependency scanning job, corresponding to what Gemnasium was
doing, you must create a `.gitlab-ci.yml` file, or update it according to doing, you must create a `.gitlab-ci.yml` file, or update it according to
@ -85,16 +89,16 @@ back to both GitLab and GitHub when completed.
The mirroring is pull-only by default, so you may create or update the file on The mirroring is pull-only by default, so you may create or update the file on
GitHub: GitHub:
![Edit gitlab-ci.yml file](img/gemnasium/edit_gitlab-ci.png) ![Edit gitlab-ci.yml file](img/gemnasium/edit_gitlab-ci.png)
1. Once your file has been committed, a new pipeline will be automatically 1. Once your file has been committed, a new pipeline will be automatically
triggered if your file is valid: triggered if your file is valid:
![pipeline](img/gemnasium/pipeline.png) ![pipeline](img/gemnasium/pipeline.png)
1. The result of the job will be visible directly from the pipeline view: 1. The result of the job will be visible directly from the pipeline view:
![security report](img/gemnasium/report.png) ![security report](img/gemnasium/report.png)
NOTE: **Note:** NOTE: **Note:**
If you don't commit very often to your project, you may want to use If you don't commit very often to your project, you may want to use

5
doc/user/project/import/manifest.md
View file

@ -1,7 +1,6 @@
# Import multiple repositories by uploading a manifest file # Import multiple repositories by uploading a manifest file
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/28811) in > [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/28811) in GitLab 11.2.
GitLab 11.2.
GitLab allows you to import all the required Git repositories GitLab allows you to import all the required Git repositories
based on a manifest file like the one used by the based on a manifest file like the one used by the
@ -56,4 +55,4 @@ You can start the import with:
to the import status page with projects list based on the manifest file. to the import status page with projects list based on the manifest file.
1. Check the list and click **Import all repositories** to start the import. 1. Check the list and click **Import all repositories** to start the import.
![Manifest status](img/manifest_status.png) ![Manifest status](img/manifest_status.png)

46
doc/user/project/integrations/mattermost_slash_commands.md
View file

@ -40,17 +40,13 @@ the administrator console.
1. Log in with an account that has admin privileges and navigate to the system 1. Log in with an account that has admin privileges and navigate to the system
console. console.
![Mattermost go to console](img/mattermost_goto_console.png) ![Mattermost go to console](img/mattermost_goto_console.png)
---
1. Click **Custom integrations** and set **Enable Custom Slash Commands**, 1. Click **Custom integrations** and set **Enable Custom Slash Commands**,
**Enable custom integrations to override usernames**, and **Override **Enable custom integrations to override usernames**, and **Override
custom integrations to override profile picture icons** to true custom integrations to override profile picture icons** to true
![Mattermost console](img/mattermost_console_integrations.png) ![Mattermost console](img/mattermost_console_integrations.png)
---
1. Click **Save** at the bottom to save the changes. 1. Click **Save** at the bottom to save the changes.
@ -62,14 +58,12 @@ the administrator console.
A screen will appear with all the values you need to copy in Mattermost as A screen will appear with all the values you need to copy in Mattermost as
described in the next step. Leave the window open. described in the next step. Leave the window open.
>**Note:** NOTE: **Note:**
GitLab will propose some values for the Mattermost settings. The only one GitLab will propose some values for the Mattermost settings. The only one
required to copy-paste as-is is the **Request URL**, all the others are just required to copy-paste as-is is the **Request URL**, all the others are just
suggestions. suggestions.
![Mattermost setup instructions](img/mattermost_config_help.png) ![Mattermost setup instructions](img/mattermost_config_help.png)
---
1. Proceed to the next step and create a slash command in Mattermost with the 1. Proceed to the next step and create a slash command in Mattermost with the
above values. above values.
@ -83,44 +77,38 @@ in a new slash command.
1. Back to Mattermost, under your team page settings, you should see the 1. Back to Mattermost, under your team page settings, you should see the
**Integrations** option. **Integrations** option.
![Mattermost team integrations](img/mattermost_team_integrations.png) ![Mattermost team integrations](img/mattermost_team_integrations.png)
---
1. Go to the **Slash Commands** integration and add a new one by clicking the 1. Go to the **Slash Commands** integration and add a new one by clicking the
**Add Slash Command** button. **Add Slash Command** button.
![Mattermost add command](img/mattermost_add_slash_command.png) ![Mattermost add command](img/mattermost_add_slash_command.png)
---
1. Fill in the options for the custom command as described in 1. Fill in the options for the custom command as described in
[step 2](#step-2-open-the-mattermost-slash-commands-service-in-gitlab). [step 2](#step-2-open-the-mattermost-slash-commands-service-in-gitlab).
>**Note:** NOTE: **Note:**
If you plan on connecting multiple projects, pick a slash command trigger If you plan on connecting multiple projects, pick a slash command trigger
word that relates to your projects such as `/gitlab-project-name` or even word that relates to your projects such as `/gitlab-project-name` or even
just `/project-name`. Only use `/gitlab` if you will only connect a single just `/project-name`. Only use `/gitlab` if you will only connect a single
project to your Mattermost team. project to your Mattermost team.
![Mattermost add command configuration](img/mattermost_slash_command_configuration.png) ![Mattermost add command configuration](img/mattermost_slash_command_configuration.png)
1. After you set up all the values, copy the token (we will use it below) and 1. After you set up all the values, copy the token (we will use it below) and
click **Done**. click **Done**.
![Mattermost slash command token](img/mattermost_slash_command_token.png) ![Mattermost slash command token](img/mattermost_slash_command_token.png)
### Step 4. Copy the Mattermost token into the Mattermost slash command service ### Step 4. Copy the Mattermost token into the Mattermost slash command service
1. In GitLab, paste the Mattermost token you copied in the previous step and 1. In GitLab, paste the Mattermost token you copied in the previous step and
check the **Active** checkbox. check the **Active** checkbox.
![Mattermost copy token to GitLab](img/mattermost_gitlab_token.png) ![Mattermost copy token to GitLab](img/mattermost_gitlab_token.png)
1. Click **Save changes** for the changes to take effect. 1. Click **Save changes** for the changes to take effect.
---
You are now set to start using slash commands in Mattermost that talk to the You are now set to start using slash commands in Mattermost that talk to the
GitLab project you configured. GitLab project you configured.

18
doc/user/project/integrations/redmine.md
View file

@ -5,18 +5,18 @@
the **Redmine** service, and fill in the required details on the page as described the **Redmine** service, and fill in the required details on the page as described
in the table below. in the table below.
| Field | Description | | Field | Description |
| ----- | ----------- | | ----- | ----------- |
| `description` | A name for the issue tracker (to differentiate between instances, for example) | | `description` | A name for the issue tracker (to differentiate between instances, for example) |
| `project_url` | The URL to the project in Redmine which is being linked to this GitLab project | | `project_url` | The URL to the project in Redmine which is being linked to this GitLab project |
| `issues_url` | The URL to the issue in Redmine project that is linked to this GitLab project. Note that the `issues_url` requires `:id` in the URL. This ID is used by GitLab as a placeholder to replace the issue number. | | `issues_url` | The URL to the issue in Redmine project that is linked to this GitLab project. Note that the `issues_url` requires `:id` in the URL. This ID is used by GitLab as a placeholder to replace the issue number. |
| `new_issue_url` | This is the URL to create a new issue in Redmine for the project linked to this GitLab project. **This is currently not being used and will be removed in a future release.** | | `new_issue_url` | This is the URL to create a new issue in Redmine for the project linked to this GitLab project. **This is currently not being used and will be removed in a future release.** |
Once you have configured and enabled Redmine you'll see the Redmine link on the GitLab project pages that takes you to the appropriate Redmine project. Once you have configured and enabled Redmine you'll see the Redmine link on the GitLab project pages that takes you to the appropriate Redmine project.
As an example, below is a configuration for a project named gitlab-ci. As an example, below is a configuration for a project named gitlab-ci.
![Redmine configuration](img/redmine_configuration.png) ![Redmine configuration](img/redmine_configuration.png)
1. To disable the internal issue tracking system in a project, navigate to the General page, expand the [permissions](../settings/index.md#sharing-and-permissions) section and switch the **Issues** toggle to disabled. 1. To disable the internal issue tracking system in a project, navigate to the General page, expand the [permissions](../settings/index.md#sharing-and-permissions) section and switch the **Issues** toggle to disabled.

6
doc/user/project/members/share_project_with_groups.md
View file

@ -20,18 +20,18 @@ To share 'Project Acme' with the 'Engineering' group:
1. For 'Project Acme' use the left navigation menu to go to **Settings > Members** 1. For 'Project Acme' use the left navigation menu to go to **Settings > Members**
![share project with groups](img/share_project_with_groups.png) ![share project with groups](img/share_project_with_groups.png)
1. Select the 'Share with group' tab 1. Select the 'Share with group' tab
1. Add the 'Engineering' group with the maximum access level of your choice 1. Add the 'Engineering' group with the maximum access level of your choice
1. Click **Share** to share it 1. Click **Share** to share it
![share project with groups tab](img/share_project_with_groups_tab.png) ![share project with groups tab](img/share_project_with_groups_tab.png)
1. After sharing 'Project Acme' with 'Engineering', the project will be listed 1. After sharing 'Project Acme' with 'Engineering', the project will be listed
on the group dashboard on the group dashboard
!['Project Acme' is listed as a shared project for 'Engineering'](img/other_group_sees_shared_project.png) !['Project Acme' is listed as a shared project for 'Engineering'](img/other_group_sees_shared_project.png)
Note that you can only share a project with: Note that you can only share a project with:

21
doc/user/project/merge_requests/merge_request_approvals.md
View file

@ -44,7 +44,7 @@ To edit the merge request approvals:
1. Navigate to your project's **Settings > General** and expand 1. Navigate to your project's **Settings > General** and expand
**Merge request approvals**. **Merge request approvals**.
![Approvals starter project empty](img/approvals_starter_project_empty.png) ![Approvals starter project empty](img/approvals_starter_project_empty.png)
1. Click **Edit**. 1. Click **Edit**.
1. Search for users or groups that will be [eligible to approve](#eligible-approvers) 1. Search for users or groups that will be [eligible to approve](#eligible-approvers)
@ -54,7 +54,7 @@ To edit the merge request approvals:
box. Note: the minimum can be 0. box. Note: the minimum can be 0.
1. Click **Update approvers**. 1. Click **Update approvers**.
![Approvals starter project edit](img/approvals_starter_project_edit.png) ![Approvals starter project edit](img/approvals_starter_project_edit.png)
The steps above are the minimum required to get approvals working in your The steps above are the minimum required to get approvals working in your
merge requests, but there are a couple more options available that might be merge requests, but there are a couple more options available that might be
@ -83,7 +83,7 @@ request approval rules:
1. Give the approval rule a name that describes the set of approvers selected. 1. Give the approval rule a name that describes the set of approvers selected.
1. Click **Add approvers** to submit the new rule. 1. Click **Add approvers** to submit the new rule.
![Approvals premium project edit](img/approvals_premium_project_edit.png) ![Approvals premium project edit](img/approvals_premium_project_edit.png)
## Multiple approval rules **(PREMIUM)** ## Multiple approval rules **(PREMIUM)**
@ -144,14 +144,17 @@ the following is possible:
- If the required number of approvals has _not_ been yet met, they can approve - If the required number of approvals has _not_ been yet met, they can approve
it by clicking the displayed **Approve** button. it by clicking the displayed **Approve** button.
![Approve](img/approve.png)
![Approve](img/approve.png)
- If the required number of approvals has already been met, they can still - If the required number of approvals has already been met, they can still
approve it by clicking the displayed **Approve additionally** button. approve it by clicking the displayed **Approve additionally** button.
![Add approval](img/approve_additionally.png)
![Add approval](img/approve_additionally.png)
- **They have already approved this merge request**: They can remove their approval. - **They have already approved this merge request**: They can remove their approval.
![Remove approval](img/remove_approval.png) ![Remove approval](img/remove_approval.png)
NOTE: **Note:** NOTE: **Note:**
The merge request author is only allowed to approve their own merge request The merge request author is only allowed to approve their own merge request
@ -159,7 +162,7 @@ if [**Prevent author approval**](#allowing-merge-request-authors-to-approve-thei
For a given merge request, if the approval restrictions have been satisfied, For a given merge request, if the approval restrictions have been satisfied,
the merge request is unblocked and can be merged. the merge request is unblocked and can be merged.
Note, that meeting the required number of approvals is a necessary, but not Note that meeting the required number of approvals is a necessary, but not
sufficient condition for unblocking a merge request from being merged. There sufficient condition for unblocking a merge request from being merged. There
are other conditions that may block it, such as merge conflicts, are other conditions that may block it, such as merge conflicts,
[pending discussions](../../discussions/index.md#only-allow-merge-requests-to-be-merged-if-all-threads-are-resolved) [pending discussions](../../discussions/index.md#only-allow-merge-requests-to-be-merged-if-all-threads-are-resolved)
@ -203,7 +206,7 @@ First, you have to enable this option in the project's settings:
1. Tick the "Can override approvers and approvals required per merge request" 1. Tick the "Can override approvers and approvals required per merge request"
checkbox checkbox
![Approvals can override](img/approvals_can_override.png) ![Approvals can override](img/approvals_can_override.png)
1. Click **Save changes** 1. Click **Save changes**
@ -259,7 +262,7 @@ new commits are pushed to the source branch of the merge request:
1. Tick the "Remove all approvals in a merge request when new commits are pushed to its source branch" 1. Tick the "Remove all approvals in a merge request when new commits are pushed to its source branch"
checkbox checkbox
![Approvals remove on push](img/approvals_remove_on_push.png) ![Approvals remove on push](img/approvals_remove_on_push.png)
1. Click **Save changes** 1. Click **Save changes**

2
doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md
View file

@ -47,7 +47,7 @@ Once you've met the requirements, to enable Let's Encrypt integration:
1. Click **Edit** in the top-right corner. 1. Click **Edit** in the top-right corner.
1. Enable Let's Encrypt integration by switching **Automatic certificate management using Let's Encrypt**: 1. Enable Let's Encrypt integration by switching **Automatic certificate management using Let's Encrypt**:
![Enable Let's Encrypt](img/lets_encrypt_integration_v12_1.png) ![Enable Let's Encrypt](img/lets_encrypt_integration_v12_1.png)
1. Click **Save changes**. 1. Click **Save changes**.

44
doc/user/project/pages/getting_started_part_two.md
View file

@ -86,17 +86,17 @@ You can also take some **optional** further steps:
- _Remove the fork relationship._ The fork relationship is necessary to contribute back to the project you originally forked from. If you don't have any intentions to do so, you can remove it. To do so, navigate to your project's **Settings**, expand **Advanced settings**, and scroll down to **Remove fork relationship**: - _Remove the fork relationship._ The fork relationship is necessary to contribute back to the project you originally forked from. If you don't have any intentions to do so, you can remove it. To do so, navigate to your project's **Settings**, expand **Advanced settings**, and scroll down to **Remove fork relationship**:
![remove fork relationship](img/remove_fork_relationship.png) ![remove fork relationship](img/remove_fork_relationship.png)
- _Make it a user or group website._ To turn a **project website** forked - _Make it a user or group website._ To turn a **project website** forked
from the Pages group into a **user/group** website, you'll need to: from the Pages group into a **user/group** website, you'll need to:
- Rename it to `namespace.gitlab.io`: go to your project's - Rename it to `namespace.gitlab.io`: go to your project's
**Settings > General** and expand **Advanced**. Scroll down to **Settings > General** and expand **Advanced**. Scroll down to
**Rename repository** and change the path to `namespace.gitlab.io`. **Rename repository** and change the path to `namespace.gitlab.io`.
- Adjust your SSG's [base URL](#urls-and-baseurls) from `"project-name"` to - Adjust your SSG's [base URL](#urls-and-baseurls) from `"project-name"` to
`""`. This setting will be at a different place for each SSG, as each of them `""`. This setting will be at a different place for each SSG, as each of them
have their own structure and file tree. Most likely, it will be in the SSG's have their own structure and file tree. Most likely, it will be in the SSG's
config file. config file.
### Create a project from scratch ### Create a project from scratch
@ -107,12 +107,12 @@ You can also take some **optional** further steps:
files to your project, add, commit and push to GitLab. files to your project, add, commit and push to GitLab.
1. From the your **Project**'s page, click **Set up CI/CD**: 1. From the your **Project**'s page, click **Set up CI/CD**:
![setup GitLab CI/CD](img/setup_ci.png) ![setup GitLab CI/CD](img/setup_ci.png)
1. Choose one of the templates from the dropbox menu. 1. Choose one of the templates from the dropbox menu.
Pick up the template corresponding to the SSG you're using (or plain HTML). Pick up the template corresponding to the SSG you're using (or plain HTML).
![gitlab-ci templates](img/choose_ci_template.png) ![gitlab-ci templates](img/choose_ci_template.png)
Once you have both site files and `.gitlab-ci.yml` in your project's Once you have both site files and `.gitlab-ci.yml` in your project's
root, GitLab CI/CD will build your site and deploy it with Pages. root, GitLab CI/CD will build your site and deploy it with Pages.
@ -123,20 +123,20 @@ where you'll find its default URL.
> **Notes:** > **Notes:**
> >
> - GitLab Pages [supports any SSG](https://about.gitlab.com/2016/06/17/ssg-overview-gitlab-pages-part-3-examples-ci/), but, > - GitLab Pages [supports any SSG](https://about.gitlab.com/2016/06/17/ssg-overview-gitlab-pages-part-3-examples-ci/), but,
if you don't find yours among the templates, you'll need > if you don't find yours among the templates, you'll need
to configure your own `.gitlab-ci.yml`. To do that, please > to configure your own `.gitlab-ci.yml`. To do that, please
read through the article [Creating and Tweaking GitLab CI/CD for GitLab Pages](getting_started_part_four.md). New SSGs are very welcome among > read through the article [Creating and Tweaking GitLab CI/CD for GitLab Pages](getting_started_part_four.md). New SSGs are very welcome among
the [example projects](https://gitlab.com/pages). If you set > the [example projects](https://gitlab.com/pages). If you set
up a new one, please > up a new one, please
[contribute](https://gitlab.com/pages/pages.gitlab.io/blob/master/CONTRIBUTING.md) > [contribute](https://gitlab.com/pages/pages.gitlab.io/blob/master/CONTRIBUTING.md)
to our examples. > to our examples.
> >
> - The second step _"Clone it to your local computer"_, can be done > - The second step _"Clone it to your local computer"_, can be done
differently, achieving the same results: instead of cloning the bare > differently, achieving the same results: instead of cloning the bare
repository to you local computer and moving your site files into it, > repository to you local computer and moving your site files into it,
you can run `git init` in your local website directory, add the > you can run `git init` in your local website directory, add the
remote URL: `git remote add origin git@gitlab.com:namespace/project-name.git`, > remote URL: `git remote add origin git@gitlab.com:namespace/project-name.git`,
then add, commit, and push to GitLab. > then add, commit, and push to GitLab.
## URLs and Baseurls ## URLs and Baseurls

2
doc/user/project/pages/index.md
View file

@ -101,7 +101,7 @@ To get started with GitLab Pages, you can either:
1. Select **Create from Template**. 1. Select **Create from Template**.
1. Choose one of the templates starting with **Pages**: 1. Choose one of the templates starting with **Pages**:
![Project templates for Pages](img/pages_project_templates_v11_8.png) ![Project templates for Pages](img/pages_project_templates_v11_8.png)
1. From the left sidebar, navigate to your project's **CI/CD > Pipelines** 1. From the left sidebar, navigate to your project's **CI/CD > Pipelines**
and click **Run pipeline** to trigger GitLab CI/CD to build and deploy your and click **Run pipeline** to trigger GitLab CI/CD to build and deploy your

6
doc/user/project/protected_branches.md
View file

@ -34,11 +34,11 @@ that the `master` branch is protected by default.
1. From the **Branch** dropdown menu, select the branch you want to protect and 1. From the **Branch** dropdown menu, select the branch you want to protect and
click **Protect**. In the screenshot below, we chose the `develop` branch. click **Protect**. In the screenshot below, we chose the `develop` branch.
![Protected branches page](img/protected_branches_page.png) ![Protected branches page](img/protected_branches_page.png)
1. Once done, the protected branch will appear in the "Protected branches" list. 1. Once done, the protected branch will appear in the "Protected branches" list.
![Protected branches list](img/protected_branches_list.png) ![Protected branches list](img/protected_branches_list.png)
## Using the Allowed to merge and Allowed to push settings ## Using the Allowed to merge and Allowed to push settings
@ -145,7 +145,7 @@ branches via GitLab's web interface:
1. In order to prevent accidental deletion, an additional confirmation is 1. In order to prevent accidental deletion, an additional confirmation is
required required
![Delete protected branches](img/protected_branches_delete.png) ![Delete protected branches](img/protected_branches_delete.png)
Deleting a protected branch is only allowed via the web interface, not via Git. Deleting a protected branch is only allowed via the web interface, not via Git.
This means that you can't accidentally delete a protected branch from your This means that you can't accidentally delete a protected branch from your

8
doc/user/project/protected_tags.md
View file

@ -20,19 +20,19 @@ To protect a tag, you need to have at least Maintainer permission level.
1. Navigate to the project's **Settings > Repository**: 1. Navigate to the project's **Settings > Repository**:
![Repository Settings](img/project_repository_settings.png) ![Repository Settings](img/project_repository_settings.png)
1. From the **Tag** dropdown menu, select the tag you want to protect or type and click **Create wildcard**. In the screenshot below, we chose to protect all tags matching `v*`: 1. From the **Tag** dropdown menu, select the tag you want to protect or type and click **Create wildcard**. In the screenshot below, we chose to protect all tags matching `v*`:
![Protected tags page](img/protected_tags_page.png) ![Protected tags page](img/protected_tags_page.png)
1. From the **Allowed to create** dropdown, select who will have permission to create matching tags and then click **Protect**: 1. From the **Allowed to create** dropdown, select who will have permission to create matching tags and then click **Protect**:
![Allowed to create tags dropdown](img/protected_tags_permissions_dropdown.png) ![Allowed to create tags dropdown](img/protected_tags_permissions_dropdown.png)
1. Once done, the protected tag will appear in the **Protected tags** list: 1. Once done, the protected tag will appear in the **Protected tags** list:
![Protected tags list](img/protected_tags_list.png) ![Protected tags list](img/protected_tags_list.png)
## Wildcard protected tags ## Wildcard protected tags