Commit c6f943db authored by Marcel Amirault's avatar Marcel Amirault Committed by Achilleas Pipinellis

Add blank lines around code blocks

All code blocks should be surrounded by blank lines
parent d9036acd
...@@ -70,6 +70,7 @@ To change the local storage path: ...@@ -70,6 +70,7 @@ To change the local storage path:
enabled: true enabled: true
storage_path: shared/dependency_proxy storage_path: shared/dependency_proxy
``` ```
1. [Restart GitLab] for the changes to take effect. 1. [Restart GitLab] for the changes to take effect.
### Using object storage ### Using object storage
......
...@@ -716,6 +716,7 @@ Example response if commit is signed: ...@@ -716,6 +716,7 @@ Example response if commit is signed:
``` ```
Example response if commit is unsigned: Example response if commit is unsigned:
```json ```json
{ {
"message": "404 GPG Signature Not Found" "message": "404 GPG Signature Not Found"
......
...@@ -634,11 +634,13 @@ Parameters: ...@@ -634,11 +634,13 @@ Parameters:
By default, groups only get 20 namespaces at a time because the API results are paginated. By default, groups only get 20 namespaces at a time because the API results are paginated.
To get more (up to 100), pass the following as an argument to the API call: To get more (up to 100), pass the following as an argument to the API call:
``` ```
/groups?per_page=100 /groups?per_page=100
``` ```
And to switch pages add: And to switch pages add:
``` ```
/groups?per_page=100&page=2 /groups?per_page=100&page=2
``` ```
......
...@@ -1331,9 +1331,11 @@ If you don't have permissions to accept this merge request - you'll get a `401` ...@@ -1331,9 +1331,11 @@ If you don't have permissions to accept this merge request - you'll get a `401`
If the merge request is already merged or closed - you get `405` and error message 'Method Not Allowed' If the merge request is already merged or closed - you get `405` and error message 'Method Not Allowed'
In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a `406` error. In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a `406` error.
``` ```
PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds
``` ```
Parameters: Parameters:
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user - `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
......
...@@ -5,6 +5,7 @@ ...@@ -5,6 +5,7 @@
**Valid access levels** **Valid access levels**
Currently, these levels are recognized: Currently, these levels are recognized:
``` ```
0 => No access 0 => No access
30 => Developer access 30 => Developer access
......
...@@ -141,6 +141,7 @@ Parameters: ...@@ -141,6 +141,7 @@ Parameters:
"message": null "message": null
} }
``` ```
The message will be `null` when creating a lightweight tag otherwise The message will be `null` when creating a lightweight tag otherwise
it will contain the annotation. it will contain the annotation.
......
...@@ -452,6 +452,7 @@ To start using Container Registry on our machine, we first need to login to the ...@@ -452,6 +452,7 @@ To start using Container Registry on our machine, we first need to login to the
```bash ```bash
docker login registry.gitlab.com docker login registry.gitlab.com
``` ```
Then we can build and push our image to GitLab: Then we can build and push our image to GitLab:
```bash ```bash
......
...@@ -69,12 +69,14 @@ correctly with your CI jobs: ...@@ -69,12 +69,14 @@ correctly with your CI jobs:
1. Next, if you are using `gitlab-runner` v1.10+, you can set the 1. Next, if you are using `gitlab-runner` v1.10+, you can set the
`GIT_SUBMODULE_STRATEGY` variable to either `normal` or `recursive` to tell `GIT_SUBMODULE_STRATEGY` variable to either `normal` or `recursive` to tell
the runner to fetch your submodules before the job: the runner to fetch your submodules before the job:
```yaml
variables: ```yaml
GIT_SUBMODULE_STRATEGY: recursive variables:
``` GIT_SUBMODULE_STRATEGY: recursive
See the [`.gitlab-ci.yml` reference](yaml/README.md#git-submodule-strategy) ```
for more details about `GIT_SUBMODULE_STRATEGY`.
See the [`.gitlab-ci.yml` reference](yaml/README.md#git-submodule-strategy)
for more details about `GIT_SUBMODULE_STRATEGY`.
1. If you are using an older version of `gitlab-runner`, then use 1. If you are using an older version of `gitlab-runner`, then use
`git submodule sync/update` in `before_script`: `git submodule sync/update` in `before_script`:
......
...@@ -129,6 +129,7 @@ merge_request: ...@@ -129,6 +129,7 @@ merge_request:
author: author:
type: type:
``` ```
If you're working on the GitLab EE repository, the entry will be added to If you're working on the GitLab EE repository, the entry will be added to
`ee/changelogs/unreleased/` instead. `ee/changelogs/unreleased/` instead.
......
...@@ -53,6 +53,7 @@ When writing a class that needs to manipulate the DOM guarantee a container opti ...@@ -53,6 +53,7 @@ When writing a class that needs to manipulate the DOM guarantee a container opti
This is useful when we need that class to be instantiated more than once in the same page. This is useful when we need that class to be instantiated more than once in the same page.
Bad: Bad:
```javascript ```javascript
class Foo { class Foo {
constructor() { constructor() {
...@@ -63,6 +64,7 @@ new Foo(); ...@@ -63,6 +64,7 @@ new Foo();
``` ```
Good: Good:
```javascript ```javascript
class Foo { class Foo {
constructor(opts) { constructor(opts) {
...@@ -72,6 +74,7 @@ class Foo { ...@@ -72,6 +74,7 @@ class Foo {
new Foo({ container: '.my-element' }); new Foo({ container: '.my-element' });
``` ```
You can find an example of the above in this [class][container-class-example]; You can find an example of the above in this [class][container-class-example];
[container-class-example]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/app/assets/javascripts/mini_pipeline_graph_dropdown.js [container-class-example]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/app/assets/javascripts/mini_pipeline_graph_dropdown.js
...@@ -25,6 +25,7 @@ If you do not provide any arguments, it will globally query and instantiate all ...@@ -25,6 +25,7 @@ If you do not provide any arguments, it will globally query and instantiate all
<!-- ... --> <!-- ... -->
<ul> <ul>
``` ```
```js ```js
const droplab = new DropLab(); const droplab = new DropLab();
droplab.init(); droplab.init();
...@@ -45,6 +46,7 @@ You can add static list items. ...@@ -45,6 +46,7 @@ You can add static list items.
<li>Static value 2</li> <li>Static value 2</li>
<ul> <ul>
``` ```
```js ```js
const droplab = new DropLab(); const droplab = new DropLab();
droplab.init(); droplab.init();
...@@ -62,6 +64,7 @@ a non-global instance of DropLab using the `DropLab.prototype.init` method. ...@@ -62,6 +64,7 @@ a non-global instance of DropLab using the `DropLab.prototype.init` method.
<!-- ... --> <!-- ... -->
<ul> <ul>
``` ```
```js ```js
const trigger = document.getElementById('trigger'); const trigger = document.getElementById('trigger');
const list = document.getElementById('list'); const list = document.getElementById('list');
...@@ -79,6 +82,7 @@ You can also add hooks to an existing DropLab instance using `DropLab.prototype. ...@@ -79,6 +82,7 @@ You can also add hooks to an existing DropLab instance using `DropLab.prototype.
<a href="#" id="trigger" data-dropdown-trigger="#list">Toggle</a> <a href="#" id="trigger" data-dropdown-trigger="#list">Toggle</a>
<ul id="list" data-dropdown><!-- ... --><ul> <ul id="list" data-dropdown><!-- ... --><ul>
``` ```
```js ```js
const droplab = new DropLab(); const droplab = new DropLab();
...@@ -109,6 +113,7 @@ for all `data-dynamic` dropdown lists tracked by that DropLab instance. ...@@ -109,6 +113,7 @@ for all `data-dynamic` dropdown lists tracked by that DropLab instance.
<li><a href="#" data-id="{{id}}">{{text}}</a></li> <li><a href="#" data-id="{{id}}">{{text}}</a></li>
</ul> </ul>
``` ```
```js ```js
const droplab = new DropLab(); const droplab = new DropLab();
...@@ -131,6 +136,7 @@ the data as the second argument and the `id` of the trigger element as the first ...@@ -131,6 +136,7 @@ the data as the second argument and the `id` of the trigger element as the first
<li><a href="#" data-id="{{id}}">{{text}}</a></li> <li><a href="#" data-id="{{id}}">{{text}}</a></li>
</ul> </ul>
``` ```
```js ```js
const droplab = new DropLab(); const droplab = new DropLab();
...@@ -160,6 +166,7 @@ dropdown lists, one of which is dynamic. ...@@ -160,6 +166,7 @@ dropdown lists, one of which is dynamic.
</ul> </ul>
</div> </div>
``` ```
```js ```js
const droplab = new DropLab(); const droplab = new DropLab();
...@@ -216,6 +223,7 @@ Some plugins require configuration values, the config object can be passed as th ...@@ -216,6 +223,7 @@ Some plugins require configuration values, the config object can be passed as th
<a href="#" id="trigger" data-dropdown-trigger="#list">Toggle</a> <a href="#" id="trigger" data-dropdown-trigger="#list">Toggle</a>
<ul id="list" data-dropdown><!-- ... --><ul> <ul id="list" data-dropdown><!-- ... --><ul>
``` ```
```js ```js
const droplab = new DropLab(); const droplab = new DropLab();
......
...@@ -17,18 +17,19 @@ Add the `Ajax` object to the plugins array of a `DropLab.prototype.init` or `Dro ...@@ -17,18 +17,19 @@ Add the `Ajax` object to the plugins array of a `DropLab.prototype.init` or `Dro
<a href="#" id="trigger" data-dropdown-trigger="#list">Toggle</a> <a href="#" id="trigger" data-dropdown-trigger="#list">Toggle</a>
<ul id="list" data-dropdown><!-- ... --><ul> <ul id="list" data-dropdown><!-- ... --><ul>
``` ```
```js ```js
const droplab = new DropLab(); const droplab = new DropLab();
const trigger = document.getElementById('trigger'); const trigger = document.getElementById('trigger');
const list = document.getElementById('list'); const list = document.getElementById('list');
droplab.addHook(trigger, list, [Ajax], { droplab.addHook(trigger, list, [Ajax], {
Ajax: { Ajax: {
endpoint: '/some-endpoint', endpoint: '/some-endpoint',
method: 'setData', method: 'setData',
}, },
}); });
``` ```
Optionally you can set `loadingTemplate` to a HTML string. This HTML string will Optionally you can set `loadingTemplate` to a HTML string. This HTML string will
......
...@@ -17,25 +17,26 @@ Add the `Filter` object to the plugins array of a `DropLab.prototype.init` or `D ...@@ -17,25 +17,26 @@ Add the `Filter` object to the plugins array of a `DropLab.prototype.init` or `D
<li><a href="#" data-id="{{id}}">{{text}}</a></li> <li><a href="#" data-id="{{id}}">{{text}}</a></li>
<ul> <ul>
``` ```
```js ```js
const droplab = new DropLab(); const droplab = new DropLab();
const trigger = document.getElementById('trigger'); const trigger = document.getElementById('trigger');
const list = document.getElementById('list'); const list = document.getElementById('list');
droplab.init(trigger, list, [Filter], { droplab.init(trigger, list, [Filter], {
Filter: { Filter: {
template: 'text', template: 'text',
}, },
}); });
droplab.addData('trigger', [{ droplab.addData('trigger', [{
id: 0, id: 0,
text: 'Jacob', text: 'Jacob',
}, { }, {
id: 1, id: 1,
text: 'Jeff', text: 'Jeff',
}]); }]);
``` ```
Above, the input string will be compared against the `test` key of the passed data objects. Above, the input string will be compared against the `test` key of the passed data objects.
......
...@@ -22,33 +22,34 @@ You can also set the `InputSetter` config to an array of objects, which will all ...@@ -22,33 +22,34 @@ You can also set the `InputSetter` config to an array of objects, which will all
<li><a href="#" data-id="{{id}}">{{text}}</a></li> <li><a href="#" data-id="{{id}}">{{text}}</a></li>
<ul> <ul>
``` ```
```js ```js
const droplab = new DropLab(); const droplab = new DropLab();
const trigger = document.getElementById('trigger'); const trigger = document.getElementById('trigger');
const list = document.getElementById('list'); const list = document.getElementById('list');
const input = document.getElementById('input'); const input = document.getElementById('input');
const div = document.getElementById('div'); const div = document.getElementById('div');
droplab.init(trigger, list, [InputSetter], { droplab.init(trigger, list, [InputSetter], {
InputSetter: [{ InputSetter: [{
input: input, input: input,
valueAttribute: 'data-id', valueAttribute: 'data-id',
} { } {
input: div, input: div,
valueAttribute: 'data-id', valueAttribute: 'data-id',
inputAttribute: 'data-selected-id', inputAttribute: 'data-selected-id',
}], }],
}); });
droplab.addData('trigger', [{ droplab.addData('trigger', [{
id: 0, id: 0,
text: 'Jacob', text: 'Jacob',
}, { }, {
id: 1, id: 1,
text: 'Jeff', text: 'Jeff',
}]); }]);
``` ```
Above, if the second list item was clicked, it would update the `#input` element Above, if the second list item was clicked, it would update the `#input` element
......
...@@ -34,6 +34,7 @@ new_feature ...@@ -34,6 +34,7 @@ new_feature
│ └── new_feature_store.js │ └── new_feature_store.js
├── index.js ├── index.js
``` ```
_For consistency purposes, we recommend you to follow the same structure._ _For consistency purposes, we recommend you to follow the same structure._
Let's look into each of them: Let's look into each of them:
......
...@@ -30,9 +30,11 @@ The following are required to install and test the app: ...@@ -30,9 +30,11 @@ The following are required to install and test the app:
1. In the **From this URL** field, provide a link to the app descriptor. The host and port must point to your GitLab instance. 1. In the **From this URL** field, provide a link to the app descriptor. The host and port must point to your GitLab instance.
For example: For example:
``` ```
https://xxxx.serveo.net/-/jira_connect/app_descriptor.json https://xxxx.serveo.net/-/jira_connect/app_descriptor.json
``` ```
1. Click **Upload**. 1. Click **Upload**.
If the install was successful, you should see the **GitLab for Jira** app under **Manage apps**. If the install was successful, you should see the **GitLab for Jira** app under **Manage apps**.
......
...@@ -246,6 +246,7 @@ irb(main):002:0> results.last.attributes.keys ...@@ -246,6 +246,7 @@ irb(main):002:0> results.last.attributes.keys
irb(main):003:0> results.where(status: "passed").average(:time).to_s irb(main):003:0> results.where(status: "passed").average(:time).to_s
=> "0.211340155844156" => "0.211340155844156"
``` ```
These results can also be placed into a PostgreSQL database by setting the These results can also be placed into a PostgreSQL database by setting the
`RSPEC_PROFILING_POSTGRES_URL` variable. This is used to profile the test suite `RSPEC_PROFILING_POSTGRES_URL` variable. This is used to profile the test suite
when running in the CI environment. when running in the CI environment.
......
...@@ -139,6 +139,7 @@ pwd ...@@ -139,6 +139,7 @@ pwd
``` ```
clear clear
``` ```
### Sample Git taskflow ### Sample Git taskflow
If you are completely new to Git, looking through some [sample taskflows](https://rogerdudler.github.io/git-guide/) will help you understand best practices for using these commands as you work. If you are completely new to Git, looking through some [sample taskflows](https://rogerdudler.github.io/git-guide/) will help you understand best practices for using these commands as you work.
...@@ -330,6 +330,7 @@ If the user is blocked via LDAP, `state` will be `ldap_blocked`. ...@@ -330,6 +330,7 @@ If the user is blocked via LDAP, `state` will be `ldap_blocked`.
"user_id": 41 "user_id": 41
} }
``` ```
**Group Member Removed:** **Group Member Removed:**
```json ```json
......
...@@ -14,9 +14,11 @@ comments: false ...@@ -14,9 +14,11 @@ comments: false
- If it's not installed, it will prompt you to install it. - If it's not installed, it will prompt you to install it.
- **Linux** - **Linux**
```bash ```bash
sudo yum install git-all sudo yum install git-all
``` ```
```bash ```bash
sudo apt-get install git-all sudo apt-get install git-all
``` ```
......
...@@ -170,6 +170,7 @@ Attach a block or paragraph to a list item using a list continuation (which you ...@@ -170,6 +170,7 @@ Attach a block or paragraph to a list item using a list continuation (which you
* [x] checked * [x] checked
* [ ] not checked * [ ] not checked
``` ```
#### Callout #### Callout
```asciidoc ```asciidoc
...@@ -188,6 +189,7 @@ first term:: description of first term ...@@ -188,6 +189,7 @@ first term:: description of first term
second term:: second term::
description of second term description of second term
``` ```
### Document Structure ### Document Structure
#### Header #### Header
...@@ -197,6 +199,7 @@ description of second term ...@@ -197,6 +199,7 @@ description of second term
Author Name <author@example.org> Author Name <author@example.org>
v1.0, 2019-01-01 v1.0, 2019-01-01
``` ```
#### Sections #### Sections
```asciidoc ```asciidoc
...@@ -217,6 +220,7 @@ include::basics.adoc[] ...@@ -217,6 +220,7 @@ include::basics.adoc[]
// define -a allow-uri-read to allow content to be read from URI // define -a allow-uri-read to allow content to be read from URI
include::https://example.org/installation.adoc[] include::https://example.org/installation.adoc[]
``` ```
### Blocks ### Blocks
```asciidoc ```asciidoc
...@@ -273,11 +277,11 @@ source - a listing that is embellished with (colorized) syntax highlighting ...@@ -273,11 +277,11 @@ source - a listing that is embellished with (colorized) syntax highlighting
---- ----
``` ```
```asciidoc ````asciidoc
\```language \```language
fenced code - a shorthand syntax for the source block fenced code - a shorthand syntax for the source block
\``` \```
``` ````
```asciidoc ```asciidoc
[,attribution,citetitle] [,attribution,citetitle]
...@@ -369,4 +373,3 @@ video::300817511[vimeo] ...@@ -369,4 +373,3 @@ video::300817511[vimeo]
// page break // page break
<<< <<<
``` ```
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