diff options
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/markdown.md | 74 | ||||
-rw-r--r-- | doc/user/packages/conan_repository/index.md | 2 | ||||
-rw-r--r-- | doc/user/packages/npm_registry/index.md | 4 | ||||
-rw-r--r-- | doc/user/packages/nuget_repository/index.md | 2 | ||||
-rw-r--r-- | doc/user/project/description_templates.md | 2 | ||||
-rw-r--r-- | doc/user/project/integrations/gitlab_slack_application.md | 2 | ||||
-rw-r--r-- | doc/user/project/integrations/hipchat.md | 2 | ||||
-rw-r--r-- | doc/user/project/integrations/irker.md | 2 | ||||
-rw-r--r-- | doc/user/project/integrations/jira.md | 2 | ||||
-rw-r--r-- | doc/user/project/integrations/prometheus_library/kubernetes.md | 8 | ||||
-rw-r--r-- | doc/user/project/new_ci_build_permissions_model.md | 8 |
11 files changed, 54 insertions, 54 deletions
diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 7ad810317f0..42d4a49fc60 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -131,26 +131,26 @@ Supported formats (named colors are not supported): Color written inside backticks will be followed by a color "chip": ```markdown -`#F00` -`#F00A` -`#FF0000` -`#FF0000AA` -`RGB(0,255,0)` -`RGB(0%,100%,0%)` -`RGBA(0,255,0,0.3)` -`HSL(540,70%,50%)` -`HSLA(540,70%,50%,0.3)` -``` - -`#F00` -`#F00A` -`#FF0000` -`#FF0000AA` -`RGB(0,255,0)` -`RGB(0%,100%,0%)` -`RGBA(0,255,0,0.3)` -`HSL(540,70%,50%)` -`HSLA(540,70%,50%,0.3)` +- `#F00` +- `#F00A` +- `#FF0000` +- `#FF0000AA` +- `RGB(0,255,0)` +- `RGB(0%,100%,0%)` +- `RGBA(0,255,0,0.3)` +- `HSL(540,70%,50%)` +- `HSLA(540,70%,50%,0.3)` +``` + +- `#F00` +- `#F00A` +- `#FF0000` +- `#FF0000AA` +- `RGB(0,255,0)` +- `RGB(0%,100%,0%)` +- `RGBA(0,255,0,0.3)` +- `HSL(540,70%,50%)` +- `HSLA(540,70%,50%,0.3)` ### Diagrams and flowcharts @@ -581,7 +581,7 @@ Quote break. GFM extends the standard Markdown standard by also supporting multiline blockquotes fenced by `>>>`: -``` +```markdown >>> If you paste a message from somewhere else @@ -630,7 +630,7 @@ def function(): 3-backtick fences. ~~~ -``` +```plaintext ~~~ Tildes are OK too. ~~~ @@ -638,20 +638,20 @@ Tildes are OK too. The three examples above render as: -``` +```python def function(): #indenting works just fine in the fenced code block s = "Python code" print s ``` -``` +```plaintext Using 4 spaces is like using 3-backtick fences. ``` -~~~ +~~~plaintext Tildes are OK too. ~~~ @@ -668,7 +668,7 @@ code when it is inline. Blocks of code are fenced by lines with three back-ticks ```` ``` ```` or three tildes `~~~`, and have the language identified at the end of the first fence: -~~~ +~~~markdown ```javascript var s = "JavaScript syntax highlighting"; alert(s); @@ -714,7 +714,7 @@ markdown = Redcarpet.new("Hello World!") puts markdown.to_html ``` -``` +```plaintext No language indicated, so no syntax highlighting. s = "There is no highlighting for this." But let's throw in a <b>tag</b>. @@ -756,7 +756,7 @@ dealing with code and names that often appear with multiple underscores. As a re GFM extends the standard Markdown standard by ignoring multiple underlines in words, to allow better rendering of Markdown documents discussing code: -```md +```markdown perform_complicated_task do_this_and_do_that_and_another_thing @@ -852,7 +852,7 @@ The IDs are generated from the content of the header according to the following Example: -``` +```markdown # This header has spaces in it ## This header has a :thumbsup: in it # This header has Unicode in it: 한글 @@ -973,7 +973,7 @@ class for the list of allowed HTML tags and attributes. In addition to the defau <dd>Is something people use sometimes.</dd> <dt>Markdown in HTML</dt> - <dd>Does *not* work **very** well. HTML <em>tags</em> will <b>always</b> work.</dd> + <dd>Does *not* work **very** well. HTML <em>tags</em> will <b>work</b>, in most cases.</dd> </dl> ``` @@ -982,7 +982,7 @@ class for the list of allowed HTML tags and attributes. In addition to the defau <dd>Is something people use sometimes.</dd> <dt>Markdown in HTML</dt> - <dd>Does *not* work **very** well. HTML <em>tags</em> will <b>always</b> work.</dd> + <dd>Does *not* work **very** well. HTML <em>tags</em> will <b>work</b>, in most cases.</dd> </dl> --- @@ -993,12 +993,12 @@ are separated into their own lines: ```html <dl> <dt>Markdown in HTML</dt> - <dd>Does *not* work **very** well. HTML tags will always work.</dd> + <dd>Does *not* work **very** well. HTML tags will work, in most cases.</dd> <dt>Markdown in HTML</dt> <dd> - Does *not* work **very** well. HTML tags will always work. + Does *not* work **very** well. HTML tags will work, in most cases. </dd> </dl> @@ -1008,12 +1008,12 @@ are separated into their own lines: <dl> <dt>Markdown in HTML</dt> - <dd>Does *not* work **very** well. HTML tags will always work.</dd> + <dd>Does *not* work **very** well. HTML tags will work, in most cases.</dd> <dt>Markdown in HTML</dt> <dd> - Does <em>not</em> work <b>very</b> well. HTML tags will always work. + Does <em>not</em> work <b>very</b> well. HTML tags will work, in most cases. </dd> </dl> @@ -1148,7 +1148,7 @@ A new line due to the previous backslash. There are two ways to create links, inline-style and reference-style: -```md +```markdown - This is an [inline-style link](https://www.google.com) - This is a [link to a repository file in the same directory](index.md) - This is a [relative link to a readme one directory higher](../README.md) @@ -1319,7 +1319,7 @@ the paragraph will appear outside the list, instead of properly indented under t Example: -``` +```markdown 1. First ordered list item Paragraph of first item. diff --git a/doc/user/packages/conan_repository/index.md b/doc/user/packages/conan_repository/index.md index c21e539f332..522d6652e7a 100644 --- a/doc/user/packages/conan_repository/index.md +++ b/doc/user/packages/conan_repository/index.md @@ -39,7 +39,7 @@ conan --version You should see the Conan version printed in the output: -``` +```plaintext Conan version 1.20.5 ``` diff --git a/doc/user/packages/npm_registry/index.md b/doc/user/packages/npm_registry/index.md index 5a3754685da..af848358a4d 100644 --- a/doc/user/packages/npm_registry/index.md +++ b/doc/user/packages/npm_registry/index.md @@ -49,7 +49,7 @@ npm --version You should see the NPM version printed in the output: -``` +```plaintext 6.10.3 ``` @@ -67,7 +67,7 @@ yarn --version You should see the version printed like so: -``` +```plaintext 1.19.1 ``` diff --git a/doc/user/packages/nuget_repository/index.md b/doc/user/packages/nuget_repository/index.md index 5d3fdf535d2..dd614c2b38e 100644 --- a/doc/user/packages/nuget_repository/index.md +++ b/doc/user/packages/nuget_repository/index.md @@ -26,7 +26,7 @@ nuget help You should see something similar to: -``` +```plaintext NuGet Version: 5.2.0.6090 usage: NuGet <command> [args] [options] Type 'NuGet help <command>' for help on a specific command. diff --git a/doc/user/project/description_templates.md b/doc/user/project/description_templates.md index d59d4eec174..84b74692725 100644 --- a/doc/user/project/description_templates.md +++ b/doc/user/project/description_templates.md @@ -91,7 +91,7 @@ It is possible to use [quick actions](quick_actions.md) within description templ Here is an example for a Bug report template: -``` +```plaintext Summary (Summarize the bug encountered concisely) diff --git a/doc/user/project/integrations/gitlab_slack_application.md b/doc/user/project/integrations/gitlab_slack_application.md index 72b1318a16a..4bc44d1d7d8 100644 --- a/doc/user/project/integrations/gitlab_slack_application.md +++ b/doc/user/project/integrations/gitlab_slack_application.md @@ -56,7 +56,7 @@ We are working on making this configurable in the future. For example, to show the issue number `1001` under the `gitlab-org/gitlab` project, you would do: -``` +```plaintext /gitlab gitlab-org/gitlab issue show 1001 ``` diff --git a/doc/user/project/integrations/hipchat.md b/doc/user/project/integrations/hipchat.md index 85c3eda1208..347f7973c84 100644 --- a/doc/user/project/integrations/hipchat.md +++ b/doc/user/project/integrations/hipchat.md @@ -25,7 +25,7 @@ allow GitLab to send messages only to *one* room. 1. In the "Send messages to this room by posting this URL" column, you should see a URL in the format: -``` +```plaintext https://api.hipchat.com/v2/room/<room>/notification?auth_token=<token> ``` diff --git a/doc/user/project/integrations/irker.md b/doc/user/project/integrations/irker.md index 47017843233..cadf01c382a 100644 --- a/doc/user/project/integrations/irker.md +++ b/doc/user/project/integrations/irker.md @@ -11,7 +11,7 @@ See the project homepage for further info: <https://gitlab.com/esr/irker> You will first need an Irker daemon. You can download the Irker code from its repository on <https://gitlab.com/esr/irker>: -``` +```shell git clone https://gitlab.com/esr/irker.git ``` diff --git a/doc/user/project/integrations/jira.md b/doc/user/project/integrations/jira.md index 1af56b79e82..681b628682b 100644 --- a/doc/user/project/integrations/jira.md +++ b/doc/user/project/integrations/jira.md @@ -119,7 +119,7 @@ link back to GitLab. This means that in comments in merge requests and commits referencing an issue, e.g., `PROJECT-7`, will add a comment in Jira issue in the format: -``` +```plaintext USER mentioned this issue in RESOURCE_NAME of [PROJECT_NAME|LINK_TO_COMMENT]: ENTITY_TITLE ``` diff --git a/doc/user/project/integrations/prometheus_library/kubernetes.md b/doc/user/project/integrations/prometheus_library/kubernetes.md index 7433210b553..ca1555c793b 100644 --- a/doc/user/project/integrations/prometheus_library/kubernetes.md +++ b/doc/user/project/integrations/prometheus_library/kubernetes.md @@ -13,13 +13,13 @@ integration services must be enabled. - Average Memory Usage (MB): - ``` + ```prometheus avg(sum(container_memory_usage_bytes{container_name!="POD",pod_name=~"^%{ci_environment_slug}-([^c].*|c([^a]|a([^n]|n([^a]|a([^r]|r[^y])))).*|)-(.*)",namespace="%{kube_namespace}"}) by (job)) without (job) / count(avg(container_memory_usage_bytes{container_name!="POD",pod_name=~"^%{ci_environment_slug}-([^c].*|c([^a]|a([^n]|n([^a]|a([^r]|r[^y])))).*|)-(.*)",namespace="%{kube_namespace}"}) without (job)) /1024/1024 ``` - Average CPU Utilization (%): - ``` + ```prometheus avg(sum(rate(container_cpu_usage_seconds_total{container_name!="POD",pod_name=~"^%{ci_environment_slug}-([^c].*|c([^a]|a([^n]|n([^a]|a([^r]|r[^y])))).*|)-(.*)",namespace="%{kube_namespace}"}[15m])) by (job)) without (job) / count(sum(rate(container_cpu_usage_seconds_total{container_name!="POD",pod_name=~"^%{ci_environment_slug}-([^c].*|c([^a]|a([^n]|n([^a]|a([^r]|r[^y])))).*|)-(.*)",namespace="%{kube_namespace}"}[15m])) by (pod_name)) ``` @@ -48,12 +48,12 @@ These metrics expect the [Deployment](https://kubernetes.io/docs/concepts/worklo - Average Memory Usage (MB) - ``` + ```prometheus avg(sum(container_memory_usage_bytes{container_name!="POD",pod_name=~"^%{ci_environment_slug}-canary-(.*)",namespace="%{kube_namespace}"}) by (job)) without (job) / count(avg(container_memory_usage_bytes{container_name!="POD",pod_name=~"^%{ci_environment_slug}-canary-(.*)",namespace="%{kube_namespace}"}) without (job)) /1024/1024 ``` - Average CPU Utilization (%) - ``` + ```prometheus avg(sum(rate(container_cpu_usage_seconds_total{container_name!="POD",pod_name=~"^%{ci_environment_slug}-canary-(.*)",namespace="%{kube_namespace}"}[15m])) by (job)) without (job) / count(sum(rate(container_cpu_usage_seconds_total{container_name!="POD",pod_name=~"^%{ci_environment_slug}-canary-(.*)",namespace="%{kube_namespace}"}[15m])) by (pod_name)) ``` diff --git a/doc/user/project/new_ci_build_permissions_model.md b/doc/user/project/new_ci_build_permissions_model.md index d1bb23396e4..4217fc792d7 100644 --- a/doc/user/project/new_ci_build_permissions_model.md +++ b/doc/user/project/new_ci_build_permissions_model.md @@ -101,14 +101,14 @@ allowing pulling and pushing Docker images from within the CI job. GitLab would create a special checkout URL like: -``` +```plaintext https://gitlab-ci-token:<project-runners-token>/gitlab.com/gitlab-org/gitlab-foss.git ``` And then the users could also use it in their CI jobs all Docker related commands to interact with GitLab Container Registry. For example: -``` +```shell docker login -u gitlab-ci-token -p $CI_JOB_TOKEN registry.gitlab.com ``` @@ -173,14 +173,14 @@ As a user: The [Job environment variable][jobenv] `CI_JOB_TOKEN` can be used to authenticate any clones of dependent repositories. For example: -``` +```shell git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/<user>/<mydependentrepo>.git ``` It can also be used for system-wide authentication (only do this in a docker container, it will overwrite ~/.netrc): -``` +```shell echo -e "machine gitlab.com\nlogin gitlab-ci-token\npassword ${CI_JOB_TOKEN}" > ~/.netrc ``` |