diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-12-11 06:07:31 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-12-11 06:07:31 +0300 |
commit | 9caed104bc903734d996161ba13a579f2be49d7c (patch) | |
tree | d7c3e6a534dfa85128f1011c4fb16f7f697d3f80 /doc | |
parent | a59c9590f5171f3638a1b2abeff55157aedc577b (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/geo/replication/database.md | 2 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 6 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 6 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 6 | ||||
-rw-r--r-- | doc/ci/environments.md | 2 | ||||
-rw-r--r-- | doc/ci/yaml/README.md | 2 | ||||
-rw-r--r-- | doc/development/documentation/index.md | 20 | ||||
-rw-r--r-- | doc/development/documentation/styleguide.md | 29 | ||||
-rw-r--r-- | doc/development/experiment_guide/index.md | 8 | ||||
-rw-r--r-- | doc/development/fe_guide/style/scss.md | 2 | ||||
-rw-r--r-- | doc/development/fe_guide/tooling.md | 2 | ||||
-rw-r--r-- | doc/development/internal_api.md | 4 | ||||
-rw-r--r-- | doc/integration/jenkins.md | 4 | ||||
-rw-r--r-- | doc/integration/vault.md | 4 | ||||
-rw-r--r-- | doc/policy/maintenance.md | 31 | ||||
-rw-r--r-- | doc/user/clusters/applications.md | 2 | ||||
-rw-r--r-- | doc/user/project/repository/repository_mirroring.md | 4 |
17 files changed, 81 insertions, 53 deletions
diff --git a/doc/administration/geo/replication/database.md b/doc/administration/geo/replication/database.md index f7da4e14e9d..dd7cf9f5710 100644 --- a/doc/administration/geo/replication/database.md +++ b/doc/administration/geo/replication/database.md @@ -35,7 +35,7 @@ The following guide assumes that: - You are using Omnibus and therefore you are using PostgreSQL 9.6 or later which includes the [`pg_basebackup` tool](https://www.postgresql.org/docs/9.6/app-pgbasebackup.html) and improved - [Foreign Data Wrapper][FDW](https://www.postgresql.org/docs/9.6/postgres-fdw.html) support. + [Foreign Data Wrapper](https://www.postgresql.org/docs/9.6/postgres-fdw.html) support. - You have a **primary** node already set up (the GitLab server you are replicating from), running Omnibus' PostgreSQL (or equivalent version), and you have a new **secondary** server set up with the same versions of the OS, diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index b9af49bd6da..0d34e3136dc 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -2815,7 +2815,7 @@ type Label { color: String! """ - Description of the label (markdown rendered as HTML for caching) + Description of the label (Markdown rendered as HTML for caching) """ description: String @@ -2917,7 +2917,7 @@ type MergeRequest implements Noteable { defaultMergeCommitMessage: String """ - Description of the merge request (markdown rendered as HTML for caching) + Description of the merge request (Markdown rendered as HTML for caching) """ description: String @@ -5112,7 +5112,7 @@ type RootStorageStatistics { packagesSize: Int! """ - The git repository size in bytes + The Git repository size in bytes """ repositorySize: Int! diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 6a41b454610..833a230fd3f 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -2647,7 +2647,7 @@ }, { "name": "repositorySize", - "description": "The git repository size in bytes", + "description": "The Git repository size in bytes", "args": [ ], @@ -7591,7 +7591,7 @@ }, { "name": "description", - "description": "Description of the label (markdown rendered as HTML for caching)", + "description": "Description of the label (Markdown rendered as HTML for caching)", "args": [ ], @@ -13656,7 +13656,7 @@ }, { "name": "description", - "description": "Description of the merge request (markdown rendered as HTML for caching)", + "description": "Description of the merge request (Markdown rendered as HTML for caching)", "args": [ ], diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 8b973c5d3b1..b96666915f9 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -399,7 +399,7 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | Name | Type | Description | | --- | ---- | ---------- | | `id` | ID! | Label ID | -| `description` | String | Description of the label (markdown rendered as HTML for caching) | +| `description` | String | Description of the label (Markdown rendered as HTML for caching) | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | | `title` | String! | Content of the label | | `color` | String! | Background color of the label | @@ -414,7 +414,7 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | `iid` | String! | Internal ID of the merge request | | `title` | String! | Title of the merge request | | `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` | -| `description` | String | Description of the merge request (markdown rendered as HTML for caching) | +| `description` | String | Description of the merge request (Markdown rendered as HTML for caching) | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | | `state` | MergeRequestState! | State of the merge request | | `createdAt` | Time! | Timestamp of when the merge request was created | @@ -749,7 +749,7 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | Name | Type | Description | | --- | ---- | ---------- | | `storageSize` | Int! | The total storage in bytes | -| `repositorySize` | Int! | The git repository size in bytes | +| `repositorySize` | Int! | The Git repository size in bytes | | `lfsObjectsSize` | Int! | The LFS objects size in bytes | | `buildArtifactsSize` | Int! | The CI artifacts size in bytes | | `packagesSize` | Int! | The packages size in bytes | diff --git a/doc/ci/environments.md b/doc/ci/environments.md index 6666b8d6145..245a4d20e2d 100644 --- a/doc/ci/environments.md +++ b/doc/ci/environments.md @@ -335,7 +335,7 @@ deploy: NOTE: **Note:** Kubernetes configuration is not supported for Kubernetes clusters that are [managed by GitLab](../user/project/clusters/index.md#gitlab-managed-clusters). -To follow progress on support for Gitlab-managed clusters, see the +To follow progress on support for GitLab-managed clusters, see the [relevant issue](https://gitlab.com/gitlab-org/gitlab/issues/38054). ### Complete example diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index 700aa37dd0c..f256977e31f 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -1456,7 +1456,7 @@ For more information, see NOTE: **Note:** Kubernetes configuration is not supported for Kubernetes clusters that are [managed by GitLab](../../user/project/clusters/index.md#gitlab-managed-clusters). -To follow progress on support for Gitlab-managed clusters, see the +To follow progress on support for GitLab-managed clusters, see the [relevant issue](https://gitlab.com/gitlab-org/gitlab/issues/38054). #### Dynamic environments diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md index 64a59796ebc..61e42ecfe83 100644 --- a/doc/development/documentation/index.md +++ b/doc/development/documentation/index.md @@ -399,7 +399,7 @@ merge request with new or changed docs is submitted, are: - The `CHANGELOG.md` does not contain duplicate versions. - No files in `doc/` are executable. - No new `README.md` was added. - - [`markdownlint`](#markdownlint). + - [markdownlint](#markdownlint). - Nanoc tests, which you can [run locally](#previewing-the-changes-live) before pushing to GitLab by executing the command `bundle exec nanoc check internal_links` (or `internal_anchors`) on your local [`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs) directory: @@ -420,7 +420,7 @@ help you catch common issues before raising merge requests for review of documen The following are some suggested linters you can install locally and sample configuration: - [`proselint`](#proselint) -- [`markdownlint`](#markdownlint), which is the same as the test run in [`docs-lint`](#testing) +- [markdownlint](#markdownlint), which is the same as the test run in [`docs-lint`](#testing) NOTE: **Note:** This list does not limit what other linters you can add to your local documentation writing toolchain. @@ -464,18 +464,18 @@ noise. The following sample `proselint` configuration disables these checks: A file with `proselint` configuration must be placed in a [valid location](https://github.com/amperser/proselint#checks). For example, `~/.config/proselint/config`. -#### `markdownlint` +#### markdownlint -[`markdownlint`](https://github.com/DavidAnson/markdownlint) checks that Markdown +[markdownlint](https://github.com/DavidAnson/markdownlint) checks that Markdown syntax follows [certain rules](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#rules), and is used by the [`docs-lint` test](#testing) with a [configuration file](#markdownlint-configuration). Our [Documentation Style Guide](styleguide.md#markdown) and [Markdown Guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/) elaborate on which choices must be made when selecting Markdown syntax for GitLab documentation. This tool helps catch deviations from those guidelines. -`markdownlint` can be used [on the command line](https://github.com/igorshubovych/markdownlint-cli#markdownlint-cli--), +markdownlint can be used [on the command line](https://github.com/igorshubovych/markdownlint-cli#markdownlint-cli--), either on a single Markdown file or on all Markdown files in a project. For example, to run -`markdownlint` on all documentation in the [`gitlab` project](https://gitlab.com/gitlab-org/gitlab), +markdownlint on all documentation in the [`gitlab` project](https://gitlab.com/gitlab-org/gitlab), run the following commands from within your `gitlab` project root directory, which will automatically detect the [`.markdownlint.json`](#markdownlint-configuration) config file in the root of the project, and test all files in `/doc` and its subdirectories: @@ -490,7 +490,7 @@ If you wish to use a different config file, use the `-c` flag: markdownlint -c <config-file-name> 'doc/**/*.md' ``` -`markdownlint` can also be run from within text editors using [plugins/extensions](https://github.com/DavidAnson/markdownlint#related), +markdownlint can also be run from within text editors using [plugins/extensions](https://github.com/DavidAnson/markdownlint#related), such as: - [Sublime Text](https://packagecontrol.io/packages/SublimeLinter-contrib-markdownlint) @@ -502,9 +502,9 @@ is in use in the four repos that are the sources for <https://docs.gitlab.com>. plugin/extension has different requirements regarding the configuration file, which is explained in each editor's docs. -##### `markdownlint` configuration +##### markdownlint configuration -Each formatting issue that `markdownlint` checks has an associated +Each formatting issue that markdownlint checks has an associated [rule](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#rules). These rules are configured in the `.markdownlint.json` files located in the root of four repos that are the sources for <https://docs.gitlab.com>: @@ -518,7 +518,7 @@ By default all rules are enabled, so the configuration file is used to disable u rules, and also to configure optional parameters for enabled rules as needed. You can also check [the issue](https://gitlab.com/gitlab-org/gitlab-foss/issues/64352) that tracked the changes required to implement these rules, and details which rules were -on or off when `markdownlint` was enabled on the docs. +on or off when markdownlint was enabled on the docs. ## Danger Bot diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index b604c94e016..385569fc8fa 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -111,11 +111,38 @@ Hard-coded HTML is valid, although it's discouraged to be used while we have `/h GitLab ensures that the Markdown used across all documentation is consistent, as well as easy to review and maintain, by [testing documentation changes](index.md#testing) with -[`markdownlint`](index.md#markdownlint). This lint test fails when any document has an issue +[markdownlint](index.md#markdownlint). This lint test fails when any document has an issue with Markdown formatting that may cause the page to render incorrectly within GitLab. It will also fail when a document is using non-standard Markdown (which may render correctly, but is not the current standard for GitLab documentation). +#### Markdown rule `MD044/proper-names` (capitalization) + +A rule that could cause confusion is `MD044/proper-names`, as it might not be immediately +clear what caused markdownlint to fail, or how to correct the failure. This rule +checks a list of known words, listed in the `.markdownlint.json` file in each project, +to verify that proper capitalization and backticks are used. Words in backticks will +be ignored by markdownlint. + +In general, product names should follow the exact capitalization of the official names +of the products, protocols, etc. + +Some examples that will fail if incorrect capitalization is used: + +- MinIO (needs capital `IO`) +- NGINX (needs all capitals) +- runit (needs lowercase `r`) + +Additionally, commands, parameters, values, filenames, etc. must be included in backticks. +For example: + +- "Change the `needs` keyword in your `.gitlab.yml`..." + - `needs` is a parameter, and `.gitlab.yml` is a file, so both need backticks. Additionally, + `.gitlab.yml` will fail markdownlint without backticks as it does not have capital G or L. +- "Run `git clone` to clone a Git repository..." + - `git clone` is a command, so it must be lowercase, while Git is the product, so + it must have a capital G. + ## Structure ### Organize by topic, not by type diff --git a/doc/development/experiment_guide/index.md b/doc/development/experiment_guide/index.md index c7a80a07c61..98086fc63ea 100644 --- a/doc/development/experiment_guide/index.md +++ b/doc/development/experiment_guide/index.md @@ -24,7 +24,7 @@ The author then adds a comment to this piece of code and adds a link to the issu ## How to create an A/B test -- [ ] Add the experiment to the `Gitlab::Experimentation::EXPERIMENTS` hash in [`experimentation.rb`](https://gitlab.com/gitlab-org/gitlab/blob/master/lib%2Fgitlab%2Fexperimentation.rb): +- Add the experiment to the `Gitlab::Experimentation::EXPERIMENTS` hash in [`experimentation.rb`](https://gitlab.com/gitlab-org/gitlab/blob/master/lib%2Fgitlab%2Fexperimentation.rb): ```ruby EXPERIMENTS = { @@ -40,7 +40,7 @@ The author then adds a comment to this piece of code and adds a link to the issu }.freeze ``` -- [ ] Use the experiment in a controller: +- Use the experiment in a controller: ```ruby class RegistrationController < Applicationcontroller @@ -55,8 +55,8 @@ The author then adds a comment to this piece of code and adds a link to the issu end ``` -- [ ] Track necessary events. See the [event tracking guide](../event_tracking/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: +- Track necessary events. See the [event tracking guide](../event_tracking/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: ``` /chatops run feature set --project=gitlab-org/gitlab experimental_sign_up_flow true diff --git a/doc/development/fe_guide/style/scss.md b/doc/development/fe_guide/style/scss.md index a8755e634be..c6424e39ac2 100644 --- a/doc/development/fe_guide/style/scss.md +++ b/doc/development/fe_guide/style/scss.md @@ -11,7 +11,7 @@ easy to maintain, and performant for the end-user. ### Utility Classes -As part of the effort for [cleaning up our CSS and moving our components into GitLab-UI](https://gitlab.com/groups/gitlab-org/-/epics/950) +As part of the effort for [cleaning up our CSS and moving our components into gitlab-ui](https://gitlab.com/groups/gitlab-org/-/epics/950) led by the [GitLab UI WG](https://gitlab.com/gitlab-com/www-gitlab-com/merge_requests/20623) we prefer the use of utility classes over adding new CSS. However, complex CSS can be addressed by adding component classes. #### Where are utility classes defined? diff --git a/doc/development/fe_guide/tooling.md b/doc/development/fe_guide/tooling.md index ec5e094cfa6..066c2575e2d 100644 --- a/doc/development/fe_guide/tooling.md +++ b/doc/development/fe_guide/tooling.md @@ -2,7 +2,7 @@ ## ESLint -We use ESLint to encapsulate and enforce frontend code standards. Our configuration may be found in the [gitlab-eslint-config](https://gitlab.com/gitlab-org/gitlab-eslint-config) project. +We use ESLint to encapsulate and enforce frontend code standards. Our configuration may be found in the [`gitlab-eslint-config`](https://gitlab.com/gitlab-org/gitlab-eslint-config) project. ### Disabling ESLint in new files diff --git a/doc/development/internal_api.md b/doc/development/internal_api.md index 18d88c37147..dbb721b6018 100644 --- a/doc/development/internal_api.md +++ b/doc/development/internal_api.md @@ -287,8 +287,6 @@ Example response: } ``` -## Notify Post Receive [UNUSED] ? - ## PostReceive Called from Gitaly after a receiving a push. This triggers the @@ -300,7 +298,7 @@ the user. |:----------|:-------|:---------|:------------| | `identifier` | string | yes | `user-[id]` or `key-[id]` Identifying the user performing the push | | `gl_repository` | string | yes | identifier of the repository being pushed to | -| `push_options` | [string] | no | array of push options | +| `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`. | ``` diff --git a/doc/integration/jenkins.md b/doc/integration/jenkins.md index 32816652ed5..fe607b2afdf 100644 --- a/doc/integration/jenkins.md +++ b/doc/integration/jenkins.md @@ -138,7 +138,7 @@ configured or there was an error reporting the status via the API. ### Merge Request event does not trigger a Jenkins Pipeline -Check the **/var/log/gitlab/gitlab-rails/production.log** file for messages like: +Check the `/var/log/gitlab/gitlab-rails/production.log` file for messages like: ```plaintext WebHook Error => Net::ReadTimeout @@ -157,7 +157,7 @@ which is set to 10 seconds by default. To fix this the `gitlab_rails['webhook_timeout']` value will need to be increased in the `gitlab.rb` config file, followed by the [`gitlab-ctl reconfigure` command](../administration/restart_gitlab.md). -If you don't find the errors above, but do find *duplicate* entries like below (in **/var/log/gitlab/gitlab-rail**), this +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): ``` diff --git a/doc/integration/vault.md b/doc/integration/vault.md index 4aca62b5fd1..68803fed35d 100644 --- a/doc/integration/vault.md +++ b/doc/integration/vault.md @@ -19,7 +19,7 @@ The following assumes you already have Vault installed and running. 1. On GitLab, click your avatar on the top-right corner, and select your user **Settings > Applications**. 1. Fill out the application **Name** and [**Redirect URI**](https://www.vaultproject.io/docs/auth/jwt.html#redirect-uris), - making sure to select the **openid** scope. + making sure to select the **OpenID** scope. 1. Save application. 1. Copy client ID and secret, or keep the page open for reference. ![GitLab OAuth provider](img/gitlab_oauth_vault_v12_6.png) @@ -42,7 +42,7 @@ The following assumes you already have Vault installed and running. 1. **Write the OIDC config:** - Next, Vault needs to be given the application ID and secret generated by Gitlab. + Next, Vault needs to be given the application ID and secret generated by GitLab. In the terminal session, run the following command to give Vault access to the GitLab application you've just created with an OpenID scope. This allows Vault to authenticate through GitLab. diff --git a/doc/policy/maintenance.md b/doc/policy/maintenance.md index 672fc5f9355..eb1193a50bd 100644 --- a/doc/policy/maintenance.md +++ b/doc/policy/maintenance.md @@ -50,7 +50,7 @@ review process a new change goes through. Including new features in patch releases is not possible as that would break [Semantic Versioning](https://semver.org/). Breaking [Semantic Versioning](https://semver.org/) has the following consequences for users that -have to adhere to various internal requirements (e.g. org. compliance, verifying new features and similar): +have to adhere to various internal requirements (for example, org. compliance, verifying new features, and similar): 1. Inability to quickly upgrade to leverage bug fixes included in patch versions. 1. Inability to quickly upgrade to leverage security fixes included in patch versions. @@ -58,9 +58,12 @@ have to adhere to various internal requirements (e.g. org. compliance, verifying In cases where a strategic user has a requirement to test a feature before it is officially released, we can offer to create a Release Candidate (RC) version that will -include the specific feature. This should be needed only in extreme cases, and can be requested for consideration by raising an issue in [release/tasks] issue tracker. -It is important to note that the Release Candidate will also contain other -features and changes as it is not possible to easily isolate a specific feature (similar reasons as noted above). The Release Candidate will be no different than any code that is deployed to GitLab.com or is publicly accessible. +include the specific feature. This should be needed only in extreme cases, and can be requested for +consideration by raising an issue in the [release/tasks](https://gitlab.com/gitlab-org/release/tasks/issues/new?issuable_template=Backporting-request) issue tracker. +It is important to note that the Release Candidate will also contain other features and changes as +it is not possible to easily isolate a specific feature (similar reasons as noted above). The +Release Candidate will be no different than any code that is deployed to GitLab.com or is publicly +accessible. ### Backporting to older releases @@ -68,11 +71,16 @@ Backporting to more than one stable release is reserved for [security releases]( In some cases however, we may need to backport *a bug fix* to more than one stable release, depending on the severity of the bug. -Decision on whether backporting a change will be performed is done at the discretion of the [current release managers][release-managers], similar to what is described in the [managing bugs] process, based on *all* of the following: +The decision on whether backporting a change will be performed is done at the discretion of the +[current release managers](https://about.gitlab.com/community/release-managers/), similar to what is +described in the [managing bugs](https://gitlab.com/gitlab-org/gitlab/blob/master/PROCESS.md#managing-bugs) process, +based on *all* of the following: -1. Estimated [severity][severity-labels] of the bug: Highest possible impact to users based on the current definition of severity. +1. Estimated [severity](../development/contributing/issue_workflow.md#severity-labels) of the bug: + Highest possible impact to users based on the current definition of severity. -1. Estimated [priority][priority-definition] of the bug: Immediate impact on all impacted users based on the above estimated severity. +1. Estimated [priority](../development/contributing/issue_workflow.md#priority-labels) of the bug: + Immediate impact on all impacted users based on the above estimated severity. 1. Potentially incurring data loss and/or security breach. @@ -83,7 +91,8 @@ the current stable stable release, and two previous monthly releases. For instance, if we release `11.2.1` with a fix for a severe bug introduced in `11.0.0`, we could backport the fix to a new `11.0.x`, and `11.1.x` patch release. -To request backporting to more than one stable release for consideration, raise an issue in [release/tasks] issue tracker. +To request backporting to more than one stable release for consideration, raise an issue in the +[release/tasks](https://gitlab.com/gitlab-org/release/tasks/issues/new?issuable_template=Backporting-request) issue tracker. ### Security releases @@ -146,9 +155,3 @@ Please see the table below for some examples: More information about the release procedures can be found in our [release documentation](https://gitlab.com/gitlab-org/release/docs). You may also want to read our [Responsible Disclosure Policy](https://about.gitlab.com/security/disclosure/). - -[release-managers]: https://about.gitlab.com/community/release-managers/ -[priority-definition]: ../development/contributing/issue_workflow.md#priority-labels -[severity-labels]: ../development/contributing/issue_workflow.html#severity-labels -[managing bugs]: https://gitlab.com/gitlab-org/gitlab/blob/master/PROCESS.md#managing-bugs -[release/tasks]: https://gitlab.com/gitlab-org/release/tasks/issues/new?issuable_template=Backporting-request diff --git a/doc/user/clusters/applications.md b/doc/user/clusters/applications.md index 46b7eabaeea..f6ca8ef7f0b 100644 --- a/doc/user/clusters/applications.md +++ b/doc/user/clusters/applications.md @@ -481,7 +481,7 @@ applications you have configured. ### Install Ingress using GitLab CI -To install ingress, define the `.gitlab/managed-apps/config.yaml` file +To install Ingress, define the `.gitlab/managed-apps/config.yaml` file with: ```yaml diff --git a/doc/user/project/repository/repository_mirroring.md b/doc/user/project/repository/repository_mirroring.md index 7d49aecb603..993c96d2ae4 100644 --- a/doc/user/project/repository/repository_mirroring.md +++ b/doc/user/project/repository/repository_mirroring.md @@ -408,8 +408,8 @@ Note that this sample has a few limitations: - It does not regard different types of authentication mechanisms for the mirror. - It does not work with forced updates (rewriting history). - Only branches that match the `whitelisted` patterns will be proxy pushed. -- The script circumvents the git hook quarantine environment because the update of `$TARGET_REPO` - is seen as a ref update and git will complain about it. +- The script circumvents the Git hook quarantine environment because the update of `$TARGET_REPO` + is seen as a ref update and Git will complain about it. ### Mirroring with Perforce Helix via Git Fusion **(STARTER)** |