Commit 513d3f58 authored by Marcel Amirault's avatar Marcel Amirault Committed by Evan Read

Fix markdown in various docs

Clean up issues that may cause the docs-lint
test to fail, such as trailing whitespace, no
EOF newline, blockquotes, etc
parent e348def8
...@@ -179,7 +179,7 @@ to make sure your VM is configured to use a _static_ public IP address (i.e. not ...@@ -179,7 +179,7 @@ to make sure your VM is configured to use a _static_ public IP address (i.e. not
or you will have to reconfigure the DNS `A` record each time Azure reassigns your VM a new public IP or you will have to reconfigure the DNS `A` record each time Azure reassigns your VM a new public IP
address. Read [IP address types and allocation methods in Azure][Azure-IP-Address-Types] to learn more. address. Read [IP address types and allocation methods in Azure][Azure-IP-Address-Types] to learn more.
## Let's open some ports! ## Let's open some ports
At this stage you should have a running and fully operational VM. However, none of the services on At this stage you should have a running and fully operational VM. However, none of the services on
your VM (e.g. GitLab) will be publicly accessible via the internet until you have opened up the your VM (e.g. GitLab) will be publicly accessible via the internet until you have opened up the
...@@ -333,6 +333,7 @@ If you're running Windows, you'll need to connect using [PuTTY] or an equivalent ...@@ -333,6 +333,7 @@ If you're running Windows, you'll need to connect using [PuTTY] or an equivalent
If you're running Linux or macOS, then you already have an SSH client installed. If you're running Linux or macOS, then you already have an SSH client installed.
> **Note:** > **Note:**
>
> - Remember that you will need to login with the username and password you specified > - Remember that you will need to login with the username and password you specified
> [when you created](#basics) your Azure VM > [when you created](#basics) your Azure VM
> - If you need to reset your VM password, read > - If you need to reset your VM password, read
......
...@@ -2,10 +2,6 @@ ...@@ -2,10 +2,6 @@
comments: false comments: false
--- ---
---
title: University | Process
---
# Suggesting improvements # Suggesting improvements
If you would like to teach a class or participate or help in any way please If you would like to teach a class or participate or help in any way please
......
...@@ -23,8 +23,6 @@ type: reference ...@@ -23,8 +23,6 @@ type: reference
as opposed to individual stable branches as opposed to individual stable branches
- Consider creating a tag for each version that gets deployed - Consider creating a tag for each version that gets deployed
## Production branch
![inline](gitlab_flow/production_branch.png) ![inline](gitlab_flow/production_branch.png)
## Release branch ## Release branch
...@@ -36,8 +34,6 @@ type: reference ...@@ -36,8 +34,6 @@ type: reference
- Cherry-pick critical bug fixes to stable branch for patch release - Cherry-pick critical bug fixes to stable branch for patch release
- Never commit bug fixes directly to stable branch - Never commit bug fixes directly to stable branch
## Release branch
![inline](gitlab_flow/release_branches.png) ![inline](gitlab_flow/release_branches.png)
## More details ## More details
......
...@@ -15,7 +15,7 @@ comments: false ...@@ -15,7 +15,7 @@ comments: false
- Adapts to nearly any workflow - Adapts to nearly any workflow
- Fast, reliable and stable file format - Fast, reliable and stable file format
## Help! ## Help
Use the tools at your disposal when you get stuck. Use the tools at your disposal when you get stuck.
......
...@@ -23,7 +23,7 @@ type: reference ...@@ -23,7 +23,7 @@ type: reference
- Adapts to nearly any workflow. - Adapts to nearly any workflow.
- Fast, reliable and stable file format. - Fast, reliable and stable file format.
## Help! ## Help
Use the tools at your disposal when you get stuck. Use the tools at your disposal when you get stuck.
......
...@@ -117,4 +117,4 @@ questions that you know someone might ask. ...@@ -117,4 +117,4 @@ questions that you know someone might ask.
Each scenario can be a third-level heading, e.g. `### Getting error message X`. Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. --> but commented out to help encourage others to add to it in the future. -->
\ No newline at end of file
...@@ -127,7 +127,7 @@ but commented out to help encourage others to add to it in the future. --> ...@@ -127,7 +127,7 @@ but commented out to help encourage others to add to it in the future. -->
GitLab administrators can force a pipeline configuration to run on every GitLab administrators can force a pipeline configuration to run on every
pipeline. pipeline.
The configuration applies to all pipelines for a GitLab instance and is The configuration applies to all pipelines for a GitLab instance and is
sourced from: sourced from:
- The [instance template repository](instance_template_repository.md). - The [instance template repository](instance_template_repository.md).
......
...@@ -6,7 +6,7 @@ type: reference ...@@ -6,7 +6,7 @@ type: reference
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/30829) in GitLab 12.2. > [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/30829) in GitLab 12.2.
This setting allows you to rate limit the requests to raw endpoints, defaults to `300` requests per minute. This setting allows you to rate limit the requests to raw endpoints, defaults to `300` requests per minute.
It can be modified in **Admin Area > Network > Performance Optimization**. It can be modified in **Admin Area > Network > Performance Optimization**.
For example, requests over `300` per minute to `https://gitlab.com/gitlab-org/gitlab-ce/raw/master/app/controllers/application_controller.rb` will be blocked. Access to the raw file will be released after 1 minute. For example, requests over `300` per minute to `https://gitlab.com/gitlab-org/gitlab-ce/raw/master/app/controllers/application_controller.rb` will be blocked. Access to the raw file will be released after 1 minute.
......
...@@ -96,7 +96,7 @@ them in a YAML file named `clair-whitelist.yml`. Read more in the ...@@ -96,7 +96,7 @@ them in a YAML file named `clair-whitelist.yml`. Read more in the
## Example ## Example
The following is a sample `.gitlab-ci.yml` that will build your Docker Image, push it to the container registry and run Container Scanning. The following is a sample `.gitlab-ci.yml` that will build your Docker Image, push it to the container registry and run Container Scanning.
```yaml ```yaml
variables: variables:
...@@ -155,4 +155,4 @@ docker: Error response from daemon: failed to copy xattrs: failed to set xattr " ...@@ -155,4 +155,4 @@ docker: Error response from daemon: failed to copy xattrs: failed to set xattr "
This is a result of a bug in Docker which is now [fixed](https://github.com/containerd/continuity/pull/138 "fs: add WithAllowXAttrErrors CopyOpt"). This is a result of a bug in Docker which is now [fixed](https://github.com/containerd/continuity/pull/138 "fs: add WithAllowXAttrErrors CopyOpt").
To prevent the error, ensure the Docker version that the Runner is using is To prevent the error, ensure the Docker version that the Runner is using is
`18.09.03` or higher. For more information, see `18.09.03` or higher. For more information, see
[issue #10241](https://gitlab.com/gitlab-org/gitlab-ee/issues/10241 "Investigate why Container Scanning is not working with NFS mounts"). [issue #10241](https://gitlab.com/gitlab-org/gitlab-ee/issues/10241 "Investigate why Container Scanning is not working with NFS mounts").
\ No newline at end of file
...@@ -153,7 +153,7 @@ Clicking on this button will create a merge request to apply the solution onto t ...@@ -153,7 +153,7 @@ Clicking on this button will create a merge request to apply the solution onto t
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/9928) in [GitLab Ultimate](https://about.gitlab.com/pricing) 12.2. > [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/9928) in [GitLab Ultimate](https://about.gitlab.com/pricing) 12.2.
Merge Request Approvals can be configured to require approval from a member Merge Request Approvals can be configured to require approval from a member
of your security team when a vulnerability would be introduced by a merge request. of your security team when a vulnerability would be introduced by a merge request.
This threshold is defined as `high`, `critical`, or `unknown` This threshold is defined as `high`, `critical`, or `unknown`
......
...@@ -452,7 +452,7 @@ Replying to a non-thread comment will convert the non-thread comment to a ...@@ -452,7 +452,7 @@ Replying to a non-thread comment will convert the non-thread comment to a
thread once the reply is submitted. This conversion is considered an edit thread once the reply is submitted. This conversion is considered an edit
to the original comment, so a note about when it was last edited will appear underneath it. to the original comment, so a note about when it was last edited will appear underneath it.
This feature only exists for Issues, Merge requests, and Epics. Commits, Snippets and Merge request diff threads are This feature only exists for Issues, Merge requests, and Epics. Commits, Snippets and Merge request diff threads are
not supported yet. not supported yet.
[ce-5022]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5022 [ce-5022]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5022
......
...@@ -358,7 +358,7 @@ the group regardless of the IP restriction. ...@@ -358,7 +358,7 @@ the group regardless of the IP restriction.
You can restrict access to groups and their underlying projects by You can restrict access to groups and their underlying projects by
allowing only users with email addresses in particular domains to be added to the group. allowing only users with email addresses in particular domains to be added to the group.
Add email domains you want to whitelist and users with emails from different Add email domains you want to whitelist and users with emails from different
domains won't be allowed to be added to this group. domains won't be allowed to be added to this group.
Some domains cannot be restricted. These are the most popular public email domains, such as: Some domains cannot be restricted. These are the most popular public email domains, such as:
...@@ -417,7 +417,7 @@ You can disable all email notifications related to the group, which also include ...@@ -417,7 +417,7 @@ You can disable all email notifications related to the group, which also include
it's subgroups and projects. it's subgroups and projects.
To enable this feature: To enable this feature:
1. Navigate to the group's **Settings > General** page. 1. Navigate to the group's **Settings > General** page.
1. Expand the **Permissions, LFS, 2FA** section, and select **Disable email notifications**. 1. Expand the **Permissions, LFS, 2FA** section, and select **Disable email notifications**.
1. Click **Save changes**. 1. Click **Save changes**.
......
...@@ -58,7 +58,7 @@ Example `CODEOWNERS` file: ...@@ -58,7 +58,7 @@ Example `CODEOWNERS` file:
\#file_with_pound.rb @owner-file-with-pound \#file_with_pound.rb @owner-file-with-pound
# Multiple codeowners can be specified, separated by spaces or tabs # Multiple codeowners can be specified, separated by spaces or tabs
CODEOWNERS @multiple @code @owners CODEOWNERS @multiple @code @owners
# Both usernames or email addresses can be used to match # Both usernames or email addresses can be used to match
# users. Everything else will be ignored. For example this will # users. Everything else will be ignored. For example this will
......
...@@ -57,5 +57,5 @@ service in GitLab. ...@@ -57,5 +57,5 @@ service in GitLab.
If builds are not triggered, ensure you entered the right GitLab IP address in If builds are not triggered, ensure you entered the right GitLab IP address in
Bamboo under 'Trigger IP addresses'. Bamboo under 'Trigger IP addresses'.
> **Note:** NOTE: **Note:**
> - Starting with GitLab 8.14.0, builds are triggered on push events. Starting with GitLab 8.14.0, builds are triggered on push events.
...@@ -6,7 +6,7 @@ To set up the mock CI service server, respond to the following endpoints ...@@ -6,7 +6,7 @@ To set up the mock CI service server, respond to the following endpoints
- `commit_status`: `#{project.namespace.path}/#{project.path}/status/#{sha}.json` - `commit_status`: `#{project.namespace.path}/#{project.path}/status/#{sha}.json`
- Have your service return `200 { status: ['failed'|'canceled'|'running'|'pending'|'success'|'success-with-warnings'|'skipped'|'not_found'] }` - Have your service return `200 { status: ['failed'|'canceled'|'running'|'pending'|'success'|'success-with-warnings'|'skipped'|'not_found'] }`
- If the service returns a 404, it is interpreted as `pending` - If the service returns a 404, it is interpreted as `pending`
- `build_page`: `#{project.namespace.path}/#{project.path}/status/#{sha}` - `build_page`: `#{project.namespace.path}/#{project.path}/status/#{sha}`
- Just where the build is linked to, doesn't matter if implemented - Just where the build is linked to, doesn't matter if implemented
......
...@@ -2,6 +2,7 @@ ...@@ -2,6 +2,7 @@
> **Note:** > **Note:**
> Starting from GitLab 8.5: > Starting from GitLab 8.5:
>
> - the `repository` key is deprecated in favor of the `project` key > - the `repository` key is deprecated in favor of the `project` key
> - the `project.ssh_url` key is deprecated in favor of the `project.git_ssh_url` key > - the `project.ssh_url` key is deprecated in favor of the `project.git_ssh_url` key
> - the `project.http_url` key is deprecated in favor of the `project.git_http_url` key > - the `project.http_url` key is deprecated in favor of the `project.git_http_url` key
...@@ -12,6 +13,7 @@ ...@@ -12,6 +13,7 @@
> >
> **Note:** > **Note:**
> Starting from GitLab 11.2: > Starting from GitLab 11.2:
>
> - The `description` field for issues, merge requests, comments, and wiki pages > - The `description` field for issues, merge requests, comments, and wiki pages
> is rewritten so that simple Markdown image references (like > is rewritten so that simple Markdown image references (like
> `![](/uploads/...)`) have their target URL changed to an absolute URL. See > `![](/uploads/...)`) have their target URL changed to an absolute URL. See
...@@ -98,11 +100,12 @@ Below are described the supported events. ...@@ -98,11 +100,12 @@ Below are described the supported events.
Triggered when you push to the repository except when pushing tags. Triggered when you push to the repository except when pushing tags.
> **Note:** When more than 20 commits are pushed at once, the `commits` webhook NOTE: **Note:**
attribute will only contain the first 20 for performance reasons. Loading When more than 20 commits are pushed at once, the `commits` webhook
detailed commit data is expensive. Note that despite only 20 commits being attribute will only contain the first 20 for performance reasons. Loading
present in the `commits` attribute, the `total_commits_count` attribute will detailed commit data is expensive. Note that despite only 20 commits being
contain the actual total. present in the `commits` attribute, the `total_commits_count` attribute will
contain the actual total.
**Request header**: **Request header**:
......
...@@ -192,7 +192,7 @@ You can also click the `+` to add more related issues. ...@@ -192,7 +192,7 @@ You can also click the `+` to add more related issues.
#### 19. Related Merge Requests #### 19. Related Merge Requests
Merge requests that were mentioned in that issue's description or in the issue thread Merge requests that were mentioned in that issue's description or in the issue thread
are listed as [related merge requests](crosslinking_issues.md#from-merge-requests) here. are listed as [related merge requests](crosslinking_issues.md#from-merge-requests) here.
Also, if the current issue was mentioned as related in another merge request, that Also, if the current issue was mentioned as related in another merge request, that
merge request will be listed here. merge request will be listed here.
......
...@@ -15,14 +15,14 @@ When you select **Manual** sorting, you can change ...@@ -15,14 +15,14 @@ When you select **Manual** sorting, you can change
the order by dragging and dropping the issues. The changed order will persist. Everyone who visits the same list will see the reordered list, with some exceptions. the order by dragging and dropping the issues. The changed order will persist. Everyone who visits the same list will see the reordered list, with some exceptions.
Each issue is assigned a relative order value, representing its relative Each issue is assigned a relative order value, representing its relative
order with respect to the other issues in the list. When you drag-and-drop reorder order with respect to the other issues in the list. When you drag-and-drop reorder
an issue, its relative order value changes accordingly. an issue, its relative order value changes accordingly.
In addition, any time that issue appears in a manually sorted list, In addition, any time that issue appears in a manually sorted list,
the updated relative order value will be used for the ordering. This means that the updated relative order value will be used for the ordering. This means that
if issue `A` is drag-and-drop reordered to be above issue `B` by any user in if issue `A` is drag-and-drop reordered to be above issue `B` by any user in
a given list inside your GitLab instance, any time those two issues are subsequently a given list inside your GitLab instance, any time those two issues are subsequently
loaded in any list in the same instance (could be a different project issue list or a loaded in any list in the same instance (could be a different project issue list or a
different group issue list, for example), that ordering will be maintained. different group issue list, for example), that ordering will be maintained.
This ordering also affects [issue boards](../issue_board.md#issue-ordering-in-a-list). This ordering also affects [issue boards](../issue_board.md#issue-ordering-in-a-list).
......
...@@ -4,8 +4,7 @@ type: reference, howto ...@@ -4,8 +4,7 @@ type: reference, howto
# Allow collaboration on merge requests across forks # Allow collaboration on merge requests across forks
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/17395) > [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/17395) in GitLab 10.6.
in GitLab 10.6.
When a user opens a merge request from a fork, they are given the option to allow When a user opens a merge request from a fork, they are given the option to allow
upstream members to collaborate with them on the source branch. This allows upstream members to collaborate with them on the source branch. This allows
......
...@@ -330,7 +330,7 @@ the dropdown) `approver` and select the user. ...@@ -330,7 +330,7 @@ the dropdown) `approver` and select the user.
Merge Request Approvals can be configured to require approval from a member Merge Request Approvals can be configured to require approval from a member
of your security team when a vulnerability would be introduced by a merge request. of your security team when a vulnerability would be introduced by a merge request.
For more information, see For more information, see
[Security approvals in merge requests](../../application_security/index.md#security-approvals-in-merge-requests-ultimate). [Security approvals in merge requests](../../application_security/index.md#security-approvals-in-merge-requests-ultimate).
<!-- ## Troubleshooting <!-- ## Troubleshooting
......
# GitLab Maven Repository **(PREMIUM)** # GitLab Maven Repository **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/5811) in > [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/5811) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.3.
[GitLab Premium](https://about.gitlab.com/pricing/) 11.3.
With the GitLab [Maven](https://maven.apache.org) Repository, every With the GitLab [Maven](https://maven.apache.org) Repository, every
project can have its own space to store its Maven artifacts. project can have its own space to store its Maven artifacts.
......
# GitLab NPM Registry **(PREMIUM)** # GitLab NPM Registry **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/5934) > [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/5934) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.7.
in [GitLab Premium](https://about.gitlab.com/pricing/) 11.7.
With the GitLab NPM Registry, every With the GitLab NPM Registry, every
project can have its own space to store NPM packages. project can have its own space to store NPM packages.
......
...@@ -92,4 +92,4 @@ You can have one DNS record or more than one combined: ...@@ -92,4 +92,4 @@ You can have one DNS record or more than one combined:
- `example.com` => `A` => `192.192.192.192` - `example.com` => `A` => `192.192.192.192`
- `www` => `CNAME` => `example.com` - `www` => `CNAME` => `example.com`
- `MX` => `mail.example.com` - `MX` => `mail.example.com`
- `example.com`=> TXT => `"google-site-verification=6P08Ow5E-8Q0m6vQ7FMAqAYIDprkVV8fUf_7hZ4Qvc8"` - `example.com`=> TXT => `"google-site-verification=6P08Ow5E-8Q0m6vQ7FMAqAYIDprkVV8fUf_7hZ4Qvc8"`
\ No newline at end of file
...@@ -100,4 +100,4 @@ _Read on about [Projects for GitLab Pages and URL structure](getting_started_par ...@@ -100,4 +100,4 @@ _Read on about [Projects for GitLab Pages and URL structure](getting_started_par
- Read through this technical overview on [Static versus Dynamic Websites](https://about.gitlab.com/2016/06/03/ssg-overview-gitlab-pages-part-1-dynamic-x-static/) - Read through this technical overview on [Static versus Dynamic Websites](https://about.gitlab.com/2016/06/03/ssg-overview-gitlab-pages-part-1-dynamic-x-static/)
- Understand [how modern Static Site Generators work](https://about.gitlab.com/2016/06/10/ssg-overview-gitlab-pages-part-2/) and what you can add to your static site - Understand [how modern Static Site Generators work](https://about.gitlab.com/2016/06/10/ssg-overview-gitlab-pages-part-2/) and what you can add to your static site
- You can use [any SSG with GitLab Pages](https://about.gitlab.com/2016/06/17/ssg-overview-gitlab-pages-part-3-examples-ci/) - You can use [any SSG with GitLab Pages](https://about.gitlab.com/2016/06/17/ssg-overview-gitlab-pages-part-3-examples-ci/)
- Fork an [example project](https://gitlab.com/pages) to build your website based upon - Fork an [example project](https://gitlab.com/pages) to build your website based upon
\ No newline at end of file
...@@ -107,11 +107,11 @@ in the pipelines settings page. ...@@ -107,11 +107,11 @@ in the pipelines settings page.
### Removing color codes ### Removing color codes
Some test coverage tools output with ANSI color codes that won't be Some test coverage tools output with ANSI color codes that won't be
parsed correctly by the regular expression and will cause coverage parsed correctly by the regular expression and will cause coverage
parsing to fail. parsing to fail.
If your coverage tool doesn't provide an option to disable color If your coverage tool doesn't provide an option to disable color
codes in the output, you can pipe the output of the coverage tool through a codes in the output, you can pipe the output of the coverage tool through a
small one line script that will strip the color codes off. small one line script that will strip the color codes off.
For example: For example:
......
...@@ -34,7 +34,7 @@ Issues or Merge Requests, both of which use Labels and Milestones, then you shou ...@@ -34,7 +34,7 @@ Issues or Merge Requests, both of which use Labels and Milestones, then you shou
#### Disabling email notifications #### Disabling email notifications
You can disable all email notifications related to the project by selecting the You can disable all email notifications related to the project by selecting the
**Disable email notifications** checkbox. Only the project owner is allowed to change **Disable email notifications** checkbox. Only the project owner is allowed to change
this setting. this setting.
......
# Advanced Syntax Search **(STARTER ONLY)** # Advanced Syntax Search **(STARTER ONLY)**
> **Notes:** > **Notes:**
>
> - Introduced in [GitLab Enterprise Starter][ee] 9.2 > - Introduced in [GitLab Enterprise Starter][ee] 9.2
> - This is the user documentation. To install and configure Elasticsearch, > - This is the user documentation. To install and configure Elasticsearch,
> visit the [administrator documentation](../../integration/elasticsearch.md). > visit the [administrator documentation](../../integration/elasticsearch.md).
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment