summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-03-25 06:07:58 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-03-25 06:07:58 +0000
commit9c83aadd2604e7e6cb1f84683f951e6b12872618 (patch)
treec0a14c87378e832e87580be382e1c8ccea188b71 /doc
parent23bc19cb73aad969c9636b8b935111645e809e54 (diff)
downloadgitlab-ce-9c83aadd2604e7e6cb1f84683f951e6b12872618.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r--doc/administration/geo/replication/troubleshooting.md2
-rw-r--r--doc/administration/high_availability/database.md4
-rw-r--r--doc/administration/monitoring/ip_whitelist.md3
-rw-r--r--doc/administration/repository_storage_types.md4
-rw-r--r--doc/administration/troubleshooting/postgresql.md6
-rw-r--r--doc/api/deploy_tokens.md10
-rw-r--r--doc/development/architecture.md2
-rw-r--r--doc/development/documentation/index.md2
-rw-r--r--doc/development/documentation/styleguide.md2
-rw-r--r--doc/development/elasticsearch.md8
-rw-r--r--doc/development/experiment_guide/index.md2
-rw-r--r--doc/development/fe_guide/development_process.md4
-rw-r--r--doc/development/fe_guide/graphql.md4
-rw-r--r--doc/development/fe_guide/style/vue.md2
-rw-r--r--doc/development/fe_guide/tooling.md16
-rw-r--r--doc/development/fe_guide/vue.md2
-rw-r--r--doc/development/fe_guide/vuex.md2
-rw-r--r--doc/development/feature_flags/controls.md12
-rw-r--r--doc/development/file_storage.md2
-rw-r--r--doc/development/geo.md10
-rw-r--r--doc/development/gotchas.md2
-rw-r--r--doc/development/i18n/externalization.md2
-rw-r--r--doc/development/import_export.md2
-rw-r--r--doc/development/import_project.md2
-rw-r--r--doc/development/instrumentation.md2
-rw-r--r--doc/development/integrations/jira_connect.md2
-rw-r--r--doc/development/internal_api.md30
-rw-r--r--doc/development/new_fe_guide/development/accessibility.md2
-rw-r--r--doc/development/new_fe_guide/tips.md2
-rw-r--r--doc/development/routing.md10
-rw-r--r--doc/development/shell_commands.md8
-rw-r--r--doc/install/installation.md4
-rw-r--r--doc/integration/gitlab.md4
-rw-r--r--doc/integration/google.md2
-rw-r--r--doc/integration/jenkins.md2
-rw-r--r--doc/integration/kerberos.md6
-rw-r--r--doc/integration/oauth2_generic.md2
-rw-r--r--doc/integration/recaptcha.md2
-rw-r--r--doc/integration/salesforce.md2
-rw-r--r--doc/integration/saml.md2
-rw-r--r--doc/integration/shibboleth.md4
-rw-r--r--doc/raketasks/user_management.md2
-rw-r--r--doc/security/rack_attack.md4
-rw-r--r--doc/subscriptions/index.md13
-rw-r--r--doc/topics/airgap/quick_start_guide.md2
-rw-r--r--doc/topics/autodevops/quick_start_guide.md2
-rw-r--r--doc/university/training/user_training.md2
-rw-r--r--doc/user/application_security/dast/index.md6
-rw-r--r--doc/user/application_security/sast/index.md2
-rw-r--r--doc/user/asciidoc.md2
-rw-r--r--doc/user/packages/npm_registry/index.md2
-rw-r--r--doc/user/project/clusters/serverless/aws.md2
-rw-r--r--doc/user/project/code_owners.md4
-rw-r--r--doc/user/project/new_ci_build_permissions_model.md2
54 files changed, 123 insertions, 115 deletions
diff --git a/doc/administration/geo/replication/troubleshooting.md b/doc/administration/geo/replication/troubleshooting.md
index f1af83d0b39..3008cea365c 100644
--- a/doc/administration/geo/replication/troubleshooting.md
+++ b/doc/administration/geo/replication/troubleshooting.md
@@ -612,7 +612,7 @@ To check the configuration:
If everything is working, you should see something like this:
- ```
+ ```plaintext
gitlabhq_geo_production=# SELECT * from information_schema.foreign_tables;
foreign_table_catalog | foreign_table_schema | foreign_table_name | foreign_server_catalog | foreign_server_name
-------------------------+----------------------+-------------------------------------------------+-------------------------+---------------------
diff --git a/doc/administration/high_availability/database.md b/doc/administration/high_availability/database.md
index 8278d667fea..4362ed3e64b 100644
--- a/doc/administration/high_availability/database.md
+++ b/doc/administration/high_availability/database.md
@@ -920,7 +920,7 @@ after it has been restored to service.
Once `repmgrd` and PostgreSQL are runnning, the node will need to follow the new
as a standby node.
- ```
+ ```shell
gitlab-ctl repmgr standby follow NEW_MASTER
```
@@ -930,7 +930,7 @@ after it has been restored to service.
Once the old master node has been unregistered from the cluster, it will need
to be setup as a new standby:
- ```
+ ```shell
gitlab-ctl repmgr standby setup NEW_MASTER
```
diff --git a/doc/administration/monitoring/ip_whitelist.md b/doc/administration/monitoring/ip_whitelist.md
index 6bb2fe81b2c..700bcc978e0 100644
--- a/doc/administration/monitoring/ip_whitelist.md
+++ b/doc/administration/monitoring/ip_whitelist.md
@@ -2,6 +2,9 @@
> Introduced in GitLab 9.4.
+NOTE: **Note:**
+We intend to [rename IP whitelist as `IP allowlist`](https://gitlab.com/gitlab-org/gitlab/-/issues/7554).
+
GitLab provides some [monitoring endpoints] that provide health check information
when probed.
diff --git a/doc/administration/repository_storage_types.md b/doc/administration/repository_storage_types.md
index 896c08d7a43..ba0d511b718 100644
--- a/doc/administration/repository_storage_types.md
+++ b/doc/administration/repository_storage_types.md
@@ -93,7 +93,7 @@ open up the page for the project.
The "Gitaly relative path" is shown there, for example:
-```
+```plaintext
"@hashed/b1/7e/b17ef6d19c7a5b1ee83b907c595526dcb1eb06db8227d650d5dda0a9f4ce8cd9.git"
```
@@ -126,7 +126,7 @@ with `.git` from the end of the directory name removed.
The output includes the project id and the project name:
-```
+```plaintext
=> #<Project id:16 it/supportteam/ticketsystem>
```
diff --git a/doc/administration/troubleshooting/postgresql.md b/doc/administration/troubleshooting/postgresql.md
index b793f0a2ebc..966db356849 100644
--- a/doc/administration/troubleshooting/postgresql.md
+++ b/doc/administration/troubleshooting/postgresql.md
@@ -121,8 +121,8 @@ In this case, the guidance we had from development was to drop deadlock_timeout
PostgresSQL defaults:
-- statement_timeout = 0 (never)
-- idle_in_transaction_session_timeout = 0 (never)
+- `statement_timeout = 0` (never)
+- `idle_in_transaction_session_timeout = 0` (never)
Comments in issue [#1](https://gitlab.com/gitlab-org/gitlab/issues/30528) indicate that these should both be set to at least a number of minutes for all Omnibus installations (so they don't hang indefinitely). However, 15s for statement_timeout is very short, and will only be effective if the underlying infrastructure is very performant.
@@ -136,7 +136,7 @@ puts c.execute('SHOW idle_in_transaction_session_timeout').to_a ;"
It may take a little while to respond.
-```
+```ruby
{"statement_timeout"=>"1min"}
{"lock_timeout"=>"0"}
{"idle_in_transaction_session_timeout"=>"1min"}
diff --git a/doc/api/deploy_tokens.md b/doc/api/deploy_tokens.md
index 8000629ba78..4d62fc857ba 100644
--- a/doc/api/deploy_tokens.md
+++ b/doc/api/deploy_tokens.md
@@ -82,7 +82,7 @@ Example response:
Creates a new deploy token for a project.
-```
+```plaintext
POST /projects/:id/deploy_tokens
```
@@ -119,7 +119,7 @@ Example response:
Removes a deploy token from the project.
-```
+```plaintext
DELETE /projects/:id/deploy_tokens/:token_id
```
@@ -144,7 +144,7 @@ These endpoints require group maintainer access or higher.
Get a list of a group's deploy tokens
-```
+```plaintext
GET /groups/:id/deploy_tokens
```
@@ -183,7 +183,7 @@ Example response:
Creates a new deploy token for a group.
-```
+```plaintext
POST /groups/:id/deploy_tokens
```
@@ -222,7 +222,7 @@ Example response:
Removes a deploy token from the group.
-```
+```plaintext
DELETE /groups/:id/deploy_tokens/:token_id
```
diff --git a/doc/development/architecture.md b/doc/development/architecture.md
index fd2a6cb0f3c..8d5368bdd28 100644
--- a/doc/development/architecture.md
+++ b/doc/development/architecture.md
@@ -207,7 +207,7 @@ Consul is a tool for service discovery and configuration. Consul is distributed,
#### Elasticsearch
-- [Project page](https://github.com/elastic/elasticsearch/blob/master/README.textile)
+- [Project page](https://github.com/elastic/elasticsearch/blob/master/README.asciidoc)
- Configuration: [Omnibus][elasticsearch-omnibus], [Charts][elasticsearch-charts], [Source][elasticsearch-source], [GDK][elasticsearch-gdk]
- Layer: Core Service (Data)
diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md
index 8897b61d6dc..21e94a3464e 100644
--- a/doc/development/documentation/index.md
+++ b/doc/development/documentation/index.md
@@ -447,7 +447,7 @@ Where `MD_DOC_PATH` points to the file or directory you would like to run lint c
If you omit it completely, it will default to the `doc/` directory.
The output should be similar to:
-```
+```plaintext
=> Linting documents at path /path/to/gitlab as <user>...
=> Checking for cURL short options...
=> Checking for CHANGELOG.md duplicate entries...
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md
index 16a175ec115..1fe83f1ea37 100644
--- a/doc/development/documentation/styleguide.md
+++ b/doc/development/documentation/styleguide.md
@@ -521,7 +521,7 @@ For ordered lists, use three spaces for each level of indentation:
You can nest full lists inside other lists using the same rules as above. If you wish
to mix types, that is also possible, as long as you don't mix items at the same level:
-```
+```markdown
1. Ordered list item one.
1. Ordered list item two.
- Nested unordered list item one.
diff --git a/doc/development/elasticsearch.md b/doc/development/elasticsearch.md
index 16a86c06317..20f9fb95440 100644
--- a/doc/development/elasticsearch.md
+++ b/doc/development/elasticsearch.md
@@ -184,7 +184,7 @@ If the current version is `v12p1`, and we need to create a new version for `v12p
You might get an error such as
-```
+```plaintext
[2018-10-31T15:54:19,762][WARN ][o.e.c.r.a.DiskThresholdMonitor] [pval5Ct]
flood stage disk watermark [95%] exceeded on
[pval5Ct7SieH90t5MykM5w][pval5Ct][/usr/local/var/lib/elasticsearch/nodes/0] free: 56.2gb[3%],
@@ -195,20 +195,20 @@ This is because you've exceeded the disk space threshold - it thinks you don't h
In addition, the `read_only_allow_delete` setting will be set to `true`. It will block indexing, `forcemerge`, etc
-```
+```shell
curl "http://localhost:9200/gitlab-development/_settings?pretty"
```
Add this to your `elasticsearch.yml` file:
-```
+```yaml
# turn off the disk allocator
cluster.routing.allocation.disk.threshold_enabled: false
```
_or_
-```
+```yaml
# set your own limits
cluster.routing.allocation.disk.threshold_enabled: true
cluster.routing.allocation.disk.watermark.flood_stage: 5gb # ES 6.x only
diff --git a/doc/development/experiment_guide/index.md b/doc/development/experiment_guide/index.md
index 66b7bd8ed0f..edfde53f5ec 100644
--- a/doc/development/experiment_guide/index.md
+++ b/doc/development/experiment_guide/index.md
@@ -58,7 +58,7 @@ The author then adds a comment to this piece of code and adds a link to the issu
- Track necessary events. See the [telemetry guide](../../telemetry/index.md) for details.
- After the merge request is merged, use [`chatops`](../../ci/chatops/README.md) to enable the feature flag and start the experiment. For visibility, please run the command in the `#s_growth` channel:
- ```
+ ```shell
/chatops run feature set --project=gitlab-org/gitlab experimental_sign_up_flow true
```
diff --git a/doc/development/fe_guide/development_process.md b/doc/development/fe_guide/development_process.md
index 92f3c82a6ea..6e078f097cd 100644
--- a/doc/development/fe_guide/development_process.md
+++ b/doc/development/fe_guide/development_process.md
@@ -10,9 +10,9 @@ Copy the content over to your issue or merge request and if something doesn't ap
This checklist is intended to help us during development of bigger features/refactorings, it's not a "use it always and every point always matches" list.
-Please use your best judgement when to use it and please contribute new points through merge requests if something comes to your mind.
+Please use your best judgment when to use it and please contribute new points through merge requests if something comes to your mind.
-```
+```markdown
### Frontend development
#### Planning development
diff --git a/doc/development/fe_guide/graphql.md b/doc/development/fe_guide/graphql.md
index a8c78903612..620ed06765c 100644
--- a/doc/development/fe_guide/graphql.md
+++ b/doc/development/fe_guide/graphql.md
@@ -149,7 +149,7 @@ Using local Apollo Cache is handy when we have a need to mock some GraphQL API r
For example, we have a [fragment](#fragments) on `DesignVersion` used in our queries:
-```
+```javascript
fragment VersionListItem on DesignVersion {
id
sha
@@ -158,7 +158,7 @@ fragment VersionListItem on DesignVersion {
We need to fetch also version author and the 'created at' property to display them in the versions dropdown but these changes are still not implemented in our API. We can change the existing fragment to get a mocked response for these new fields:
-```
+```javascript
fragment VersionListItem on DesignVersion {
id
sha
diff --git a/doc/development/fe_guide/style/vue.md b/doc/development/fe_guide/style/vue.md
index 8f69792287b..b571707edfd 100644
--- a/doc/development/fe_guide/style/vue.md
+++ b/doc/development/fe_guide/style/vue.md
@@ -294,7 +294,7 @@ Please check this [rules](https://github.com/vuejs/eslint-plugin-vue#bulb-rules)
1. Tag order in `.vue` file
- ```
+ ```html
<script>
// ...
</script>
diff --git a/doc/development/fe_guide/tooling.md b/doc/development/fe_guide/tooling.md
index 066c2575e2d..0e8f5ed05ed 100644
--- a/doc/development/fe_guide/tooling.md
+++ b/doc/development/fe_guide/tooling.md
@@ -64,36 +64,36 @@ The easiest way to include prettier in your workflow is by setting up your prefe
Please take care that you only let Prettier format the same file types as the global Yarn script does (.js, .vue, and .scss). In VSCode by example you can easily exclude file formats in your settings file:
-```
+```json
"prettier.disableLanguages": [
"json",
"markdown"
- ],
+ ]
```
### Yarn Script
The following yarn scripts are available to do global formatting:
-```
+```shell
yarn prettier-staged-save
```
Updates all currently staged files (based on `git diff`) with Prettier and saves the needed changes.
-```
+```shell
yarn prettier-staged
```
Checks all currently staged files (based on `git diff`) with Prettier and log which files would need manual updating to the console.
-```
+```shell
yarn prettier-all
```
Checks all files with Prettier and logs which files need manual updating to the console.
-```
+```shell
yarn prettier-all-save
```
@@ -103,13 +103,13 @@ The source of these Yarn scripts can be found in `/scripts/frontend/prettier.js`
#### Scripts during Conversion period
-```
+```shell
node ./scripts/frontend/prettier.js check-all ./vendor/
```
This will go over all files in a specific folder check it.
-```
+```shell
node ./scripts/frontend/prettier.js save-all ./vendor/
```
diff --git a/doc/development/fe_guide/vue.md b/doc/development/fe_guide/vue.md
index 96bc89675fe..aeedd57fd83 100644
--- a/doc/development/fe_guide/vue.md
+++ b/doc/development/fe_guide/vue.md
@@ -25,7 +25,7 @@ In some features implemented with Vue.js, like the [issue board][issue-boards]
or [environments table][environments-table]
you can find a clear separation of concerns:
-```
+```plaintext
new_feature
├── components
│ └── component.vue
diff --git a/doc/development/fe_guide/vuex.md b/doc/development/fe_guide/vuex.md
index fd8ba0297c5..65661b0cc3b 100644
--- a/doc/development/fe_guide/vuex.md
+++ b/doc/development/fe_guide/vuex.md
@@ -22,7 +22,7 @@ _Note:_ The action itself will not update the state, only a mutation should upda
When using Vuex at GitLab, separate these concerns into different files to improve readability:
-```
+```plaintext
└── store
├── index.js # where we assemble modules and export the store
├── actions.js # actions
diff --git a/doc/development/feature_flags/controls.md b/doc/development/feature_flags/controls.md
index a9a75791db7..f17ac55a809 100644
--- a/doc/development/feature_flags/controls.md
+++ b/doc/development/feature_flags/controls.md
@@ -12,7 +12,7 @@ Follow the Chatops document to [request access](../chatops_on_gitlabcom.md#reque
Once you are added to the project test if your access propagated,
run:
-```
+```shell
/chatops run feature --help
```
@@ -70,7 +70,7 @@ and <https://dev.gitlab.org>.
For example, to enable a feature for 25% of all users, run the following in
Slack:
-```
+```shell
/chatops run feature set new_navigation_bar 25 --dev
/chatops run feature set new_navigation_bar 25 --staging
```
@@ -92,7 +92,7 @@ feature enabled, you can roll out the change to GitLab.com.
Similar to above, to enable a feature for 25% of all users, run the following in
Slack:
-```
+```shell
/chatops run feature set new_navigation_bar 25
```
@@ -117,13 +117,13 @@ Feature gates can also be actor based, for example a feature could first be
enabled for only the `gitlab` project. The project is passed by supplying a
`--project` flag:
-```
+```shell
/chatops run feature set --project=gitlab-org/gitlab some_feature true
```
For groups the `--group` flag is available:
-```
+```shell
/chatops run feature set --group=gitlab-org some_feature true
```
@@ -131,7 +131,7 @@ Note that actor-based gates are applied before percentages. For example, conside
`group/project` as `gitlab-org/gitlab` and a given example feature as `some_feature`, if
you run these 2 commands:
-```
+```shell
/chatops run feature set --project=gitlab-org/gitlab some_feature true
/chatops run feature set some_feature 25
```
diff --git a/doc/development/file_storage.md b/doc/development/file_storage.md
index bc3c16bd45d..adfb92acc54 100644
--- a/doc/development/file_storage.md
+++ b/doc/development/file_storage.md
@@ -60,7 +60,7 @@ hash of the project ID instead, if project migrates to the new approach (introdu
Files are stored at multiple locations and use different path schemes.
All the `GitlabUploader` derived classes should comply with this path segment schema:
-```
+```plaintext
| GitlabUploader
| ----------------------- + ------------------------- + --------------------------------- + -------------------------------- |
| `<gitlab_root>/public/` | `uploads/-/system/` | `user/avatar/:id/` | `:filename` |
diff --git a/doc/development/geo.md b/doc/development/geo.md
index c4ce9fed283..d3df2b421de 100644
--- a/doc/development/geo.md
+++ b/doc/development/geo.md
@@ -134,7 +134,7 @@ The **secondary** node authenticates itself via a [JWT request](https://jwt.io/)
When the **secondary** node wishes to download a file, it sends an
HTTP request with the `Authorization` header:
-```
+```plaintext
Authorization: GL-Geo <access_key>:<JWT payload>
```
@@ -146,7 +146,7 @@ file for the right database ID. For example, for an LFS object, the
request must also include the SHA256 sum of the file. An example JWT
payload looks like:
-```
+```yaml
{ "data": { sha256: "31806bb23580caab78040f8c45d329f5016b0115" }, iat: "1234567890" }
```
@@ -199,13 +199,13 @@ contains the schema and migrations for this database.
To write a migration for the database, use the `GeoMigrationGenerator`:
-```
+```shell
rails g geo_migration [args] [options]
```
To migrate the tracking database, run:
-```
+```shell
bundle exec rake geo:db:migrate
```
@@ -252,7 +252,7 @@ Failure to do this will prevent the **secondary** node from
functioning properly. The **secondary** node will generate error
messages, as the following PostgreSQL error:
-```
+```sql
ERROR: relation "gitlab_secondary.ci_job_artifacts" does not exist at character 323
STATEMENT: SELECT a.attname, format_type(a.atttypid, a.atttypmod),
pg_get_expr(d.adbin, d.adrelid), a.attnotnull, a.atttypid, a.atttypmod
diff --git a/doc/development/gotchas.md b/doc/development/gotchas.md
index 5e9722d9586..8f077e613b7 100644
--- a/doc/development/gotchas.md
+++ b/doc/development/gotchas.md
@@ -101,7 +101,7 @@ end
in a prepended module, which is very likely the case in EE. We could see
error like this:
- ```
+ ```plaintext
1.1) Failure/Error: expect_any_instance_of(ApplicationSetting).to receive_messages(messages)
Using `any_instance` to stub a method (elasticsearch_indexing) that has been defined on a prepended module (EE::ApplicationSetting) is not supported.
```
diff --git a/doc/development/i18n/externalization.md b/doc/development/i18n/externalization.md
index 2595ee5b6d3..5c6e31d0a37 100644
--- a/doc/development/i18n/externalization.md
+++ b/doc/development/i18n/externalization.md
@@ -488,7 +488,7 @@ The linter will take the following into account:
The errors are grouped per file, and per message ID:
-```
+```plaintext
Errors in `locale/zh_HK/gitlab.po`:
PO-syntax errors
SimplePoParser::ParserErrorSyntax error in lines
diff --git a/doc/development/import_export.md b/doc/development/import_export.md
index 9dde5422642..c969523cd40 100644
--- a/doc/development/import_export.md
+++ b/doc/development/import_export.md
@@ -63,7 +63,7 @@ class StuckImportJobsWorker
Marked stuck import jobs as failed. JIDs: xyz
```
-```
+```plaintext
+-----------+ +-----------------------------------+
|Export Job |--->| Calls ActiveRecord `as_json` and |
+-----------+ | `to_json` on all project models |
diff --git a/doc/development/import_project.md b/doc/development/import_project.md
index 3cdf2b8977a..5059608ad5c 100644
--- a/doc/development/import_project.md
+++ b/doc/development/import_project.md
@@ -148,7 +148,7 @@ In this section we'll detail any known issues we've seen when trying to import a
If you're attempting to import a large project into a development environment, you may see Gitaly throw an error about too many calls or invocations, for example:
-```
+```plaintext
Error importing repository into qa-perf-testing/gitlabhq - GitalyClient#call called 31 times from single request. Potential n+1?
```
diff --git a/doc/development/instrumentation.md b/doc/development/instrumentation.md
index 55b42bb6ef9..fd01d0ea405 100644
--- a/doc/development/instrumentation.md
+++ b/doc/development/instrumentation.md
@@ -87,7 +87,7 @@ Ruby code. In case of the above snippet you'd run the following:
This will print out something along the lines of:
-```
+```plaintext
From: /path/to/your/gitlab/lib/gitlab/metrics/instrumentation.rb @ line 148:
Owner: #<Module:0x0055f0865c6d50>
Visibility: public
diff --git a/doc/development/integrations/jira_connect.md b/doc/development/integrations/jira_connect.md
index 838358cb540..8e619c3b0a2 100644
--- a/doc/development/integrations/jira_connect.md
+++ b/doc/development/integrations/jira_connect.md
@@ -31,7 +31,7 @@ The following are required to install and test the app:
For example:
- ```
+ ```plaintext
https://xxxx.serveo.net/-/jira_connect/app_descriptor.json
```
diff --git a/doc/development/internal_api.md b/doc/development/internal_api.md
index b0c35b57422..b9d287d11b0 100644
--- a/doc/development/internal_api.md
+++ b/doc/development/internal_api.md
@@ -34,7 +34,7 @@ Gitaly.
When called from Gitaly in a `pre-receive` hook the changes are passed
and those are validated to determine if the push is allowed.
-```
+```plaintext
POST /internal/allowed
```
@@ -57,7 +57,7 @@ curl --request POST --header "Gitlab-Shared-Secret: <Base64 encoded token>" --da
Example response:
-```
+```json
{
"status": true,
"gl_repository": "project-3",
@@ -103,7 +103,7 @@ Example request:
curl --request POST --header "Gitlab-Shared-Secret: <Base64 encoded token>" --data "key_id=11&project=gnuwget/wget2" http://localhost:3001/api/v4/internal/lfs_authenticate
```
-```
+```json
{
"username": "root",
"lfs_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImFjdG9yIjoicm9vdCJ9LCJqdGkiOiIyYWJhZDcxZC0xNDFlLTQ2NGUtOTZlMi1mODllYWRiMGVmZTYiLCJpYXQiOjE1NzAxMTc2NzYsIm5iZiI6MTU3MDExNzY3MSwiZXhwIjoxNTcwMTE5NDc2fQ.g7atlBw1QMY7QEBVPE0LZ8ZlKtaRzaMRmNn41r2YITM",
@@ -126,7 +126,7 @@ lookup](../administration/operations/fast_ssh_key_lookup.md).
|:----------|:-------|:---------|:------------|
| `key` | string | yes | SSH key as passed by OpenSSH to GitLab-shell |
-```
+```plaintext
GET /internal/authorized_keys
```
@@ -138,7 +138,7 @@ curl --request GET --header "Gitlab-Shared-Secret: <Base64 encoded secret>""http
Example response:
-```
+```json
{
"id": 11,
"title": "admin@example.com",
@@ -161,7 +161,7 @@ discovers the user associated with an SSH key.
| `key_id` | integer | no | The id of the SSH key used as found in the authorized-keys file or through the `/authorized_keys` check |
| `username` | string | no | Username of the user being looked up, used by GitLab-shell when authenticating using a certificate |
-```
+```plaintext
GET /internal/discover
```
@@ -173,7 +173,7 @@ curl --request GET --header "Gitlab-Shared-Secret: <Base64 encoded secret>" "htt
Example response:
-```
+```json
{
"id": 7,
"name": "Dede Eichmann",
@@ -190,7 +190,7 @@ Example response:
This get's some generic information about the instance. This is used
by Geo nodes to get information about eachother
-```
+```plaintext
GET /internal/check
```
@@ -202,7 +202,7 @@ curl --request GET --header "Gitlab-Shared-Secret: <Base64 encoded secret>" "htt
Example response:
-```
+```json
{
"api_version": "v4",
"gitlab_version": "12.3.0-pre",
@@ -226,7 +226,7 @@ recovery codes based on their SSH key
| `key_id` | integer | no | The id of the SSH key used as found in the authorized-keys file or through the `/authorized_keys` check |
| `user_id` | integer | no | **Deprecated** User_id for which to generate new recovery codes |
-```
+```plaintext
GET /internal/two_factor_recovery_codes
```
@@ -238,7 +238,7 @@ curl --request POST --header "Gitlab-Shared-Secret: <Base64 encoded secret>" --d
Example response:
-```
+```json
{
"success": true,
"recovery_codes": [
@@ -269,7 +269,7 @@ for a push that might be accepted.
|:----------|:-------|:---------|:------------|
| `gl_repository` | string | yes | repository identifier for the repository receiving the push |
-```
+```plaintext
POST /internal/pre_receive
```
@@ -281,7 +281,7 @@ curl --request POST --header "Gitlab-Shared-Secret: <Base64 encoded secret>" --d
Example response:
-```
+```json
{
"reference_counter_increased": true
}
@@ -301,7 +301,7 @@ the user.
| `push_options` | string array | no | array of push options |
| `changes` | string | no | refs to be updated in the push in the format `oldrev newrev refname\n`. |
-```
+```plaintext
POST /internal/post_receive
```
@@ -313,7 +313,7 @@ curl --request POST --header "Gitlab-Shared-Secret: <Base64 encoded secret>" --d
Example response:
-```
+```json
{
"messages": [
{
diff --git a/doc/development/new_fe_guide/development/accessibility.md b/doc/development/new_fe_guide/development/accessibility.md
index 7a15e9eb6be..8d9f7ca5069 100644
--- a/doc/development/new_fe_guide/development/accessibility.md
+++ b/doc/development/new_fe_guide/development/accessibility.md
@@ -27,7 +27,7 @@ On the other hand, if an icon is crucial to understand the context we should do
In forms we should use the `for` attribute in the label statement:
-```
+```html
<div>
<label for="name">Fill in your name:</label>
<input type="text" id="name" name="name">
diff --git a/doc/development/new_fe_guide/tips.md b/doc/development/new_fe_guide/tips.md
index 657da1be1a7..2e2f5e8f47d 100644
--- a/doc/development/new_fe_guide/tips.md
+++ b/doc/development/new_fe_guide/tips.md
@@ -4,7 +4,7 @@
To clear production compiled assets created with `yarn webpack-prod` you can run:
-```
+```shell
yarn clean
```
diff --git a/doc/development/routing.md b/doc/development/routing.md
index 91b7ae7651e..97837a917a2 100644
--- a/doc/development/routing.md
+++ b/doc/development/routing.md
@@ -7,13 +7,13 @@ support subgroups, GitLab project and group routes use the wildcard
character to match project and group routes. For example, we might have
a path such as:
-```
+```plaintext
/gitlab-com/customer-success/north-america/west/customerA
```
However, paths can be ambiguous. Consider the following example:
-```
+```plaintext
/gitlab-com/edit
```
@@ -29,7 +29,7 @@ number of [reserved names](../user/reserved_names.md).
We have a number of global routes. For example:
-```
+```plaintext
/-/health
/-/metrics
```
@@ -40,7 +40,7 @@ Every group route must be under the `/-/` scope.
Examples:
-```
+```plaintext
gitlab-org/-/edit
gitlab-org/-/activity
gitlab-org/-/security/dashboard
@@ -56,7 +56,7 @@ client or other software requires something different.
Examples:
-```
+```plaintext
gitlab-org/gitlab/-/activity
gitlab-org/gitlab/-/jobs/123
gitlab-org/gitlab/-/settings/repository
diff --git a/doc/development/shell_commands.md b/doc/development/shell_commands.md
index 29fee58ed8a..b71fcbdc2ab 100644
--- a/doc/development/shell_commands.md
+++ b/doc/development/shell_commands.md
@@ -71,19 +71,21 @@ Make the difference between options and arguments clear to the argument parsers
To understand what `--` does, consider the problem below.
-```
+```shell
# Example
$ echo hello > -l
$ cat -l
+
cat: illegal option -- l
usage: cat [-benstuv] [file ...]
```
In the example above, the argument parser of `cat` assumes that `-l` is an option. The solution in the example above is to make it clear to `cat` that `-l` is really an argument, not an option. Many Unix command line tools follow the convention of separating options from arguments with `--`.
-```
+```shell
# Example (continued)
$ cat -- -l
+
hello
```
@@ -203,7 +205,7 @@ validates :import_url, format: { with: URI.regexp(%w(ssh git http https)) }
Suppose the user submits the following as their import URL:
-```
+```plaintext
file://git:/tmp/lol
```
diff --git a/doc/install/installation.md b/doc/install/installation.md
index deef2cef21b..2526da31882 100644
--- a/doc/install/installation.md
+++ b/doc/install/installation.md
@@ -329,7 +329,7 @@ use of extensions and concurrent index removal, you need at least PostgreSQL 9.2
1. Check if the `pg_trgm` extension is enabled:
- ```shell
+ ```sql
SELECT true AS enabled
FROM pg_available_extensions
WHERE name = 'pg_trgm'
@@ -338,7 +338,7 @@ use of extensions and concurrent index removal, you need at least PostgreSQL 9.2
If the extension is enabled this will produce the following output:
- ```
+ ```plaintext
enabled
---------
t
diff --git a/doc/integration/gitlab.md b/doc/integration/gitlab.md
index e8c104bbe6f..36810e7c513 100644
--- a/doc/integration/gitlab.md
+++ b/doc/integration/gitlab.md
@@ -15,7 +15,7 @@ GitLab.com will generate an application ID and secret key for you to use.
- Name: This can be anything. Consider something like `<Organization>'s GitLab` or `<Your Name>'s GitLab` or something else descriptive.
- Redirect URI:
- ```
+ ```plaintext
http://your-gitlab.example.com/import/gitlab/callback
http://your-gitlab.example.com/users/auth/gitlab/callback
```
@@ -63,7 +63,7 @@ GitLab.com will generate an application ID and secret key for you to use.
For installations from source:
- ```
+ ```yaml
- { name: 'gitlab', app_id: 'YOUR_APP_ID',
app_secret: 'YOUR_APP_SECRET',
args: { scope: 'api' } }
diff --git a/doc/integration/google.md b/doc/integration/google.md
index 38cc33e3971..ee7e7fd6193 100644
--- a/doc/integration/google.md
+++ b/doc/integration/google.md
@@ -28,7 +28,7 @@ In Google's side:
- **Authorized redirect URIs** - Enter your domain name followed by the
callback URIs one at a time:
- ```
+ ```plaintext
https://gitlab.example.com/users/auth/google_oauth2/callback
https://gitlab.example.com/-/google_api/auth/callback
```
diff --git a/doc/integration/jenkins.md b/doc/integration/jenkins.md
index 9f3a52cf4ef..77912a543d0 100644
--- a/doc/integration/jenkins.md
+++ b/doc/integration/jenkins.md
@@ -160,7 +160,7 @@ in the `gitlab.rb` config file, followed by the [`gitlab-ctl reconfigure` comman
If you don't find the errors above, but do find *duplicate* entries like below (in `/var/log/gitlab/gitlab-rail`), this
could also indicate that [webhook requests are timing out](../user/project/integrations/webhooks.md#receiving-duplicate-or-multiple-webhook-requests-triggered-by-one-event):
-```
+```plaintext
2019-10-25_04:22:41.25630 2019-10-25T04:22:41.256Z 1584 TID-ovowh4tek WebHookWorker JID-941fb7f40b69dff3d833c99b INFO: start
2019-10-25_04:22:41.25630 2019-10-25T04:22:41.256Z 1584 TID-ovowh4tek WebHookWorker JID-941fb7f40b69dff3d833c99b INFO: start
```
diff --git a/doc/integration/kerberos.md b/doc/integration/kerberos.md
index 68cf193a434..b77f7a952aa 100644
--- a/doc/integration/kerberos.md
+++ b/doc/integration/kerberos.md
@@ -33,7 +33,7 @@ system's Kerberos settings.
The keytab is a sensitive file and must be readable by the GitLab user. Set
ownership and protect the file appropriately:
-```
+```shell
sudo chown git /etc/http.keytab
sudo chmod 0600 /etc/http.keytab
```
@@ -243,7 +243,7 @@ With Kerberos SPNEGO authentication, the browser is expected to send a list of
mechanisms it supports to GitLab. If it doesn't support any of the mechanisms
GitLab supports, authentication will fail with a message like this in the log:
-```
+```plaintext
OmniauthKerberosSpnegoController: failed to process Negotiate/Kerberos authentication: gss_accept_sec_context did not return GSS_S_COMPLETE: An unsupported mechanism was requested Unknown error
```
@@ -282,7 +282,7 @@ fatal: Authentication failed for '<KRB5 path>'
If you are using Git v2.11 or newer and see the above error when cloning, you can
set the `http.emptyAuth` Git option to `true` to fix this:
-```
+```shell
git config --global http.emptyAuth true
```
diff --git a/doc/integration/oauth2_generic.md b/doc/integration/oauth2_generic.md
index c53c5751f1f..7fd96d727b5 100644
--- a/doc/integration/oauth2_generic.md
+++ b/doc/integration/oauth2_generic.md
@@ -26,7 +26,7 @@ This strategy is designed to allow configuration of the simple OmniAuth SSO proc
The redirect URI you provide when registering the application should be:
- ```
+ ```plaintext
http://your-gitlab.host.com/users/auth/oauth2_generic/callback
```
diff --git a/doc/integration/recaptcha.md b/doc/integration/recaptcha.md
index 10613129490..4f3140e4cb9 100644
--- a/doc/integration/recaptcha.md
+++ b/doc/integration/recaptcha.md
@@ -23,7 +23,7 @@ user logins via passwords, the `X-GitLab-Show-Login-Captcha` HTTP header must
be set. For example, in NGINX, this can be done via the `proxy_set_header`
configuration variable:
-```
+```nginx
proxy_set_header X-GitLab-Show-Login-Captcha 1;
```
diff --git a/doc/integration/salesforce.md b/doc/integration/salesforce.md
index d0e25ae2d44..5272e9fd5e5 100644
--- a/doc/integration/salesforce.md
+++ b/doc/integration/salesforce.md
@@ -60,7 +60,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must [create
For installation from source:
- ```
+ ```yaml
- { name: 'salesforce',
app_id: 'SALESFORCE_CLIENT_ID',
app_secret: 'SALESFORCE_CLIENT_SECRET'
diff --git a/doc/integration/saml.md b/doc/integration/saml.md
index 3597fe6df1e..b4f5bfda8c5 100644
--- a/doc/integration/saml.md
+++ b/doc/integration/saml.md
@@ -129,7 +129,7 @@ To ease configuration, most IdP accept a metadata URL for the application to pro
configuration information to the IdP. To build the metadata URL for GitLab, append
`users/auth/saml/metadata` to the HTTPS URL of your GitLab installation, for instance:
-```
+```plaintext
https://gitlab.example.com/users/auth/saml/metadata
```
diff --git a/doc/integration/shibboleth.md b/doc/integration/shibboleth.md
index 4cc686cc0b6..8c456e7d3d1 100644
--- a/doc/integration/shibboleth.md
+++ b/doc/integration/shibboleth.md
@@ -66,7 +66,7 @@ The following changes are needed to enable Shibboleth:
The file should look like this:
- ```
+ ```ruby
external_url 'https://gitlab.example.com'
gitlab_rails['internal_api_url'] = 'https://gitlab.example.com'
@@ -101,7 +101,7 @@ On the sign in page, there should now be a "Sign in with: Shibboleth" icon below
The order of the first 2 Location directives is important. If they are reversed,
you will not get a Shibboleth session!
-```
+```plaintext
<Location />
Require all granted
ProxyPassReverse http://127.0.0.1:8181
diff --git a/doc/raketasks/user_management.md b/doc/raketasks/user_management.md
index 637f3604d98..ffb1baa0b6e 100644
--- a/doc/raketasks/user_management.md
+++ b/doc/raketasks/user_management.md
@@ -52,7 +52,7 @@ bundle exec rake gitlab:import:all_users_to_all_groups RAILS_ENV=production
- Enable this setting to keep new users blocked until they have been cleared by the admin (default: false).
-```
+```plaintext
block_auto_created_users: false
```
diff --git a/doc/security/rack_attack.md b/doc/security/rack_attack.md
index c5bbd0db035..9ce2a9bb1ae 100644
--- a/doc/security/rack_attack.md
+++ b/doc/security/rack_attack.md
@@ -177,13 +177,13 @@ In case you want to remove a blocked IP, follow these steps:
1. You can remove the block using the following syntax, replacing `<ip>` with
the actual IP that is blacklisted:
- ```
+ ```plaintext
del cache:gitlab:rack::attack:allow2ban:ban:<ip>
```
1. Confirm that the key with the IP no longer shows up:
- ```
+ ```plaintext
keys *rack::attack*
```
diff --git a/doc/subscriptions/index.md b/doc/subscriptions/index.md
index 07197d457fb..562422c8000 100644
--- a/doc/subscriptions/index.md
+++ b/doc/subscriptions/index.md
@@ -248,12 +248,15 @@ Seat Link sends to GitLab daily a count of all users in connected self-managed i
Seat Link is mandatory because we need the user count data to enable prorated billing. Seat Link provides **only** the following information to GitLab:
- Date
-- Historical maximum user count
- License key
+- Historical maximum user count
-Here is an example of the POST request:
+For air-gapped or closed network customers, the existing [true-up model](#users-over-license) will be used. Prorated charges are not possible without user count data.
-```plaintext
+<details>
+<summary>Click here to view example content of a Seat Link POST request.</summary>
+
+<pre><code>
{
date: '2020-01-29',
license_key: 'ZXlKa1lYUmhJam9pWm5WNmVsTjVZekZ2YTJoV2NucDBh
@@ -292,9 +295,9 @@ SlRORE4xUjFaYVJGb3JlWGM5UFZ4dUlpd2lhWFlpt2lKV00yRnNVbk5RTjJk
Sg0KU1hNMGExaE9SVGR2V2pKQlBUMWNiaUo5DQo=',
max_historical_user_count: 10
}
-```
+</code></pre>
-For air-gapped or closed network customers, the existing [true-up model](#users-over-license) will be used. Prorated charges are not possible without user count data.
+</details>
### Renew or change a GitLab.com subscription
diff --git a/doc/topics/airgap/quick_start_guide.md b/doc/topics/airgap/quick_start_guide.md
index c4c02af3c85..a9c41e2f2c8 100644
--- a/doc/topics/airgap/quick_start_guide.md
+++ b/doc/topics/airgap/quick_start_guide.md
@@ -150,7 +150,7 @@ sudo update-ca-certificates
If all goes well, this is what you should see:
-```
+```plaintext
1 added, 0 removed; done.
Running hooks in /etc/ca-certificates/update.d...
done.
diff --git a/doc/topics/autodevops/quick_start_guide.md b/doc/topics/autodevops/quick_start_guide.md
index d5730d16296..9d37f6e12d0 100644
--- a/doc/topics/autodevops/quick_start_guide.md
+++ b/doc/topics/autodevops/quick_start_guide.md
@@ -239,7 +239,7 @@ After a few minutes you'll notice that there was a failure in a test.
This means there's a test that was 'broken' by our change.
Navigating into the `test` job that failed, you can see what the broken test is:
-```
+```plaintext
Failure:
WelcomeControllerTest#test_should_get_index [/app/test/controllers/welcome_controller_test.rb:7]:
<You're on Rails!> expected but was
diff --git a/doc/university/training/user_training.md b/doc/university/training/user_training.md
index d181d86e9fd..663ae0126c9 100644
--- a/doc/university/training/user_training.md
+++ b/doc/university/training/user_training.md
@@ -294,7 +294,7 @@ git push origin <branch> -f
You may end up with a commit log that looks like this:
-```
+```plaintext
Fix issue #13
Test
Fix
diff --git a/doc/user/application_security/dast/index.md b/doc/user/application_security/dast/index.md
index e12ee9e18f1..ff4ea13c392 100644
--- a/doc/user/application_security/dast/index.md
+++ b/doc/user/application_security/dast/index.md
@@ -217,7 +217,7 @@ It's also possible to add the `Gitlab-DAST-Permission` header via a proxy.
The following config allows NGINX to act as a reverse proxy and add the `Gitlab-DAST-Permission` [header](http://nginx.org/en/docs/http/ngx_http_headers_module.html#add_header):
-```
+```nginx
# default.conf
server {
listen 80;
@@ -237,7 +237,7 @@ to add the `Gitlab-DAST-Permission` [header](https://httpd.apache.org/docs/curre
To do so, add the following lines to `httpd.conf`:
-```
+```plaintext
# httpd.conf
LoadModule proxy_module modules/mod_proxy.so
LoadModule proxy_connect_module modules/mod_proxy_connect.so
@@ -472,7 +472,7 @@ Since it keeps most of its information in memory during a scan,
it is possible for DAST to run out of memory while scanning large applications.
This results in the following error:
-```
+```plaintext
[zap.out] java.lang.OutOfMemoryError: Java heap space
```
diff --git a/doc/user/application_security/sast/index.md b/doc/user/application_security/sast/index.md
index a00ec6bedeb..5991fe8cf01 100644
--- a/doc/user/application_security/sast/index.md
+++ b/doc/user/application_security/sast/index.md
@@ -518,7 +518,7 @@ For SAST with all [supported languages and frameworks](#supported-languages-and-
import the following default SAST analyzer images from `registry.gitlab.com` to your local "offline"
registry:
-```
+```plaintext
registry.gitlab.com/gitlab-org/security-products/analyzers/bandit:2
registry.gitlab.com/gitlab-org/security-products/analyzers/brakeman:2
registry.gitlab.com/gitlab-org/security-products/analyzers/eslint:2
diff --git a/doc/user/asciidoc.md b/doc/user/asciidoc.md
index b9b346d3be4..c35d1da5a88 100644
--- a/doc/user/asciidoc.md
+++ b/doc/user/asciidoc.md
@@ -17,7 +17,7 @@ Line breaks are not preserved.
Line comments, which are lines that start with `//`, are skipped:
-```
+```asciidoc
// this is a comment
```
diff --git a/doc/user/packages/npm_registry/index.md b/doc/user/packages/npm_registry/index.md
index 5801a30cc4e..e5cd45ee707 100644
--- a/doc/user/packages/npm_registry/index.md
+++ b/doc/user/packages/npm_registry/index.md
@@ -224,7 +224,7 @@ it is not possible due to a naming collision. For example:
The regex that is used for naming is validating all package names from all package managers:
-```
+```plaintext
/\A\@?(([\w\-\.\+]*)\/)*([\w\-\.]+)@?(([\w\-\.\+]*)\/)*([\w\-\.]*)\z/
```
diff --git a/doc/user/project/clusters/serverless/aws.md b/doc/user/project/clusters/serverless/aws.md
index 4c36c1fa4ed..0f3eea14efc 100644
--- a/doc/user/project/clusters/serverless/aws.md
+++ b/doc/user/project/clusters/serverless/aws.md
@@ -140,7 +140,7 @@ NOTE: **Note:**
In your GitLab deploy stage log, there will be output containing your AWS Lambda endpoint URL.
The log line will look similar to this:
-```
+```plaintext
endpoints:
GET - https://u768nzby1j.execute-api.us-east-1.amazonaws.com/production/hello
```
diff --git a/doc/user/project/code_owners.md b/doc/user/project/code_owners.md
index 4ab615a1008..49083be77dc 100644
--- a/doc/user/project/code_owners.md
+++ b/doc/user/project/code_owners.md
@@ -29,7 +29,7 @@ the users from last pattern matching the file are displayed on the
blob page of the given file. For example, you have the following
`CODEOWNERS` file:
-```
+```plaintext
README.md @user1
# This line would also match the file README.md
@@ -68,7 +68,7 @@ escaped using `\#` to address files for which the name starts with a
Example `CODEOWNERS` file:
-```
+```plaintext
# This is an example code owners file, lines starting with a `#` will
# be ignored.
diff --git a/doc/user/project/new_ci_build_permissions_model.md b/doc/user/project/new_ci_build_permissions_model.md
index 09af6d05690..51ea070f60a 100644
--- a/doc/user/project/new_ci_build_permissions_model.md
+++ b/doc/user/project/new_ci_build_permissions_model.md
@@ -213,7 +213,7 @@ project for which the job is triggered.
This is how an example usage can look like:
-```
+```yaml
test:
script:
- docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY