diff --git a/doc/push_rules/push_rules.md b/doc/push_rules/push_rules.md index 99a5ac8ed3b7036eb1d043bbcc967f9b195dcdaf..05ed7216495e7c77ce3a3cf64ed6ab4773a4bc62 100644 --- a/doc/push_rules/push_rules.md +++ b/doc/push_rules/push_rules.md @@ -182,7 +182,7 @@ bash_history > Introduced in [GitLab Starter](https://about.gitlab.com/pricing/) 7.10. -Each file name contained in a Git push is compared to the regular expression in this field. Filenames in Git consist of both the file's name and any directory that may precede it. A singular regular expression can contain multiple independent matches used as exclusions. File names can be broadly matched to any location in the repository, or restricted to specific locations. Filenames can also be partial matches used to exclude file types by extension. +Each filename contained in a Git push is compared to the regular expression in this field. Filenames in Git consist of both the file's name and any directory that may precede it. A singular regular expression can contain multiple independent matches used as exclusions. File names can be broadly matched to any location in the repository, or restricted to specific locations. Filenames can also be partial matches used to exclude file types by extension. The following examples make use of regex string boundary characters which match the beginning of a string (`^`), and the end (`$`). They also include instances where either the directory path or the filename can include `.` or `/`. Both of these special regex characters have to be escaped with a backslash `\\` to be used as normal characters in a match condition. diff --git a/doc/raketasks/migrate_snippets.md b/doc/raketasks/migrate_snippets.md index 8050a8a38e5467713b1a2e2391b6666c879da27d..244ff4f2b56956fa7ce148cbe1d9a9e51eee3dbb 100644 --- a/doc/raketasks/migrate_snippets.md +++ b/doc/raketasks/migrate_snippets.md @@ -14,7 +14,7 @@ and users can update it directly through Git. Nevertheless, existing GitLab Snippets have to be migrated to this new functionality. For each snippet, a new repository is created and the snippet content is committed -to the repository inside a file whose name is the file name used in the snippet +to the repository inside a file whose name is the filename used in the snippet as well. GitLab performs this migration through a [Background Migration](../development/background_migrations.md) diff --git a/doc/security/webhooks.md b/doc/security/webhooks.md index 0bb8e90d38f7ddc4b02d2fbcef2361cb1a5233f5..bed998a5c849196b3c68a52093fd23e313a9ce0b 100644 --- a/doc/security/webhooks.md +++ b/doc/security/webhooks.md @@ -26,7 +26,7 @@ sent. Webhook requests are made by the GitLab server itself and use a single (optional) secret token per hook for authorization (instead of a user or -repo-specific token). As a result, these may have broader access than +repository-specific token). As a result, these may have broader access than intended to everything running on the server hosting the webhook (which may include the GitLab server or API itself, e.g., `http://localhost:123`). Depending on the called webhook, this may also result in network access diff --git a/doc/topics/git/lfs/index.md b/doc/topics/git/lfs/index.md index f6e0cdee2cfd4c3a92768cd7d394ee677e2715e4..6179175b4cd14af08fe8c4550d070064638d9a2a 100644 --- a/doc/topics/git/lfs/index.md +++ b/doc/topics/git/lfs/index.md @@ -96,7 +96,7 @@ git lfs fetch origin master Make sure your files aren't listed in `.gitignore`, otherwise, they will be ignored by Git thus will not be pushed to the remote repository. -### Migrate an existing repo to Git LFS +### Migrate an existing repository to Git LFS Read the documentation on how to [migrate an existing Git repository with Git LFS](migrate_to_git_lfs.md). diff --git a/doc/topics/git/lfs/migrate_from_git_annex_to_git_lfs.md b/doc/topics/git/lfs/migrate_from_git_annex_to_git_lfs.md index 30be9c42f01bef6fa1fae8b3fa932bfe10aa2026..3bd754aabfb14860baadbd5ca1361759f1613acc 100644 --- a/doc/topics/git/lfs/migrate_from_git_annex_to_git_lfs.md +++ b/doc/topics/git/lfs/migrate_from_git_annex_to_git_lfs.md @@ -71,7 +71,7 @@ Fire up a terminal, navigate to your Git repository and: git push ``` -### Disabling Git Annex in your repo +### Disabling Git Annex in your repository Before changing anything, make sure you have a backup of your repository first. There are a couple of ways to do that, but you can simply clone it to another @@ -164,7 +164,7 @@ At this point, you have two options. Either add, commit and push the files directly back to GitLab or switch to Git LFS. We will tackle the LFS switch in the next section. -### Enabling Git LFS in your repo +### Enabling Git LFS in your repository Git LFS is enabled by default on all GitLab products (GitLab CE, GitLab EE, GitLab.com), therefore, you don't need to do anything server-side. diff --git a/doc/topics/git/lfs/migrate_to_git_lfs.md b/doc/topics/git/lfs/migrate_to_git_lfs.md index 941fc281e4c6fe12860f9ab6efa1883eede3a204..ef2675db6d402d4ae3d2a436b95fbe98e4de8629 100644 --- a/doc/topics/git/lfs/migrate_to_git_lfs.md +++ b/doc/topics/git/lfs/migrate_to_git_lfs.md @@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w description: "How to migrate an existing Git repository to Git LFS with BFG." --- -# Migrate a Git repo into Git LFS with BFG +# Migrate a Git repository into Git LFS with BFG Using Git LFS can help you to reduce the size of your Git repository and improve its performance. @@ -38,7 +38,6 @@ Before beginning, make sure: Storage is required for the entire history of all files. - All the team members you share the repository with have pushed all changes. Branches based on the repository before applying this method cannot be merged. - Branches based on the repo before applying this method cannot be merged. To follow this tutorial, you need: @@ -74,7 +73,7 @@ Consider an example upstream project, `git@gitlab.com:gitlab-tests/test-git-lfs- 1. Clone `--mirror` the repository: Cloning with the mirror flag creates a bare repository. - This ensures you get all the branches within the repo. + This ensures you get all the branches within the repository. It creates a directory called `<repo-name>.git` (in our example, `test-git-lfs-repo-migration.git`), diff --git a/doc/topics/git/partial_clone.md b/doc/topics/git/partial_clone.md index 590a37d01283cb8628657fc349ac66ac1e9b8d40..fa42cfd6e5b3fbae827ea86aff0da0bad84a59a6 100644 --- a/doc/topics/git/partial_clone.md +++ b/doc/topics/git/partial_clone.md @@ -229,7 +229,7 @@ remove filtering: `pack-<SHA1>.promisor` file, which should be empty and should be deleted. 1. Remove partial clone configuration. The partial clone-related configuration - variables should be removed from Git config files. Usually only the following + variables should be removed from Git configuration files. Usually only the following configuration must be removed: - `remote.origin.promisor`. - `remote.origin.partialclonefilter`. diff --git a/doc/topics/gitlab_flow.md b/doc/topics/gitlab_flow.md index 292e35922d63e8e3d4b68905bb7bd9bf8b02fa05..87d8129dc7f70665b23083feb2bdb428e7715a37 100644 --- a/doc/topics/gitlab_flow.md +++ b/doc/topics/gitlab_flow.md @@ -22,7 +22,7 @@ It offers a simple, transparent, and effective way to work with Git. When converting to Git, you have to get used to the fact that it takes three steps to share a commit with colleagues. Most version control systems have only one step: committing from the working copy to a shared server. -In Git, you add files from the working copy to the staging area. After that, you commit them to your local repo. +In Git, you add files from the working copy to the staging area. After that, you commit them to your local repository. The third step is pushing to a shared remote repository. After getting used to these three steps, the next challenge is the branching model. diff --git a/doc/university/training/topics/getting_started.md b/doc/university/training/topics/getting_started.md index f5c91b9481303cf5eed161d99544e3c3afc289a0..fd600624a25beb3a79e7670511089c2df43ffab3 100644 --- a/doc/university/training/topics/getting_started.md +++ b/doc/university/training/topics/getting_started.md @@ -25,7 +25,7 @@ comments: false - To instantiate a central repository a `--bare` flag is required. - Bare repositories don't allow file editing or committing changes. -- Create a bare repo with: +- Create a bare repository with: ```shell git init --bare project-name.git diff --git a/doc/university/training/topics/unstage.md b/doc/university/training/topics/unstage.md index 7e7530aba7577eebd376e0acd8225e4e7c700a2c..30d26854135835234563f0fdb90d4040a5dddd35 100644 --- a/doc/university/training/topics/unstage.md +++ b/doc/university/training/topics/unstage.md @@ -19,7 +19,7 @@ comments: false git checkout -- <file> ``` -- To remove a file from disk and repo use `git rm` and to remove a directory use the `-r` flag: +- To remove a file from disk and repository, use `git rm`. To remove a directory, use the `-r` flag: ```shell git rm '*.txt' diff --git a/doc/user/project/integrations/jira_integrations.md b/doc/user/project/integrations/jira_integrations.md index f15a5ee4429c48ad414a51da1222d1fbbcd19855..3c91fd3549fe1db0ebdba5281bd69b3d9cd53666 100644 --- a/doc/user/project/integrations/jira_integrations.md +++ b/doc/user/project/integrations/jira_integrations.md @@ -30,6 +30,6 @@ The following Jira integrations allow different types of cross-referencing betwe | Mention of Jira issue ID in GitLab issue/MR is reflected in the Jira issue | Yes, as a Jira comment with the GitLab issue/MR title and a link back to it. Its first mention also adds the GitLab page to the Jira issue under “Web linksâ€. | Yes, in the issue’s Development panel | | Mention of Jira issue ID in GitLab commit message is reflected in the issue | Yes. The entire commit message is added to the Jira issue as a comment and under “Web linksâ€, each with a link back to the commit in GitLab. | Yes, in the issue’s Development panel and optionally with a custom comment on the Jira issue using Jira Smart Commits. | | Mention of Jira issue ID in GitLab branch names is reflected in Jira issue | No | Yes, in the issue’s Development panel | -| Record Jira time tracking info against an issue | No | Yes. Time can be specified via Jira Smart Commits. | +| Record Jira time tracking information against an issue | No | Yes. Time can be specified via Jira Smart Commits. | | Transition or close a Jira issue with a Git commit or merge request | Yes. Only a single transition type, typically configured to close the issue by setting it to Done. | Yes. Transition to any state using Jira Smart Commits. | | Display a list of Jira issues | Yes **(PREMIUM)** | No | diff --git a/doc/user/project/pages/getting_started/pages_forked_sample_project.md b/doc/user/project/pages/getting_started/pages_forked_sample_project.md index b6ab650ca13e400478e580aca2bf83bcd745f798..c7916b7c01e1ba834d21f6be6464272b47264a6b 100644 --- a/doc/user/project/pages/getting_started/pages_forked_sample_project.md +++ b/doc/user/project/pages/getting_started/pages_forked_sample_project.md @@ -50,7 +50,7 @@ You can take some **optional** further steps: If you set the repository path to `gitlab-tests.gitlab.io`, the resulting URL for your Pages website is `https://gitlab-tests.gitlab.io`. -  +  - Now go to your SSG's configuration file and change the [base URL](../getting_started_part_one.md#urls-and-baseurls) from `"project-name"` to `""`. The project name setting varies by SSG and may not be in the configuration file. diff --git a/doc/user/project/pages/lets_encrypt_for_gitlab_pages.md b/doc/user/project/pages/lets_encrypt_for_gitlab_pages.md index 86ea19ba5127ea05de5ff65a67181769f8ec91f2..b5932fc876616ba5b0d4100de9e94646fecc8375 100644 --- a/doc/user/project/pages/lets_encrypt_for_gitlab_pages.md +++ b/doc/user/project/pages/lets_encrypt_for_gitlab_pages.md @@ -103,7 +103,7 @@ might be slightly different. Follow the `http://example.com/.well-known/acme-challenge/Rxnv6WKo95hsuLVX3osmT6LgmzsJKSaK9htlPToohOP` to allow Let's Encrypt to verify the ownership of your domain, therefore, it needs to be part of the website content under the - repo's [`public`](index.md#how-it-works) folder. + repository's [`public`](index.md#how-it-works) folder. 1. Add, commit, and push the file into your repository in GitLab. Once the pipeline passes, press **Enter** on your terminal to continue issuing your diff --git a/doc/user/project/repository/index.md b/doc/user/project/repository/index.md index 880e0f2f805a90b36a194d777fcd9c7f6ffcb5d3..c4f5d330f631ee6db3b2c9bf413a304100b58421 100644 --- a/doc/user/project/repository/index.md +++ b/doc/user/project/repository/index.md @@ -31,7 +31,7 @@ that you [connect with GitLab via SSH](../../../ssh/README.md). ## Files Use a repository to store your files in GitLab. In [GitLab 12.10 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/33806), -you'll see on the repository's file tree an icon next to the file name +you'll see on the repository's file tree an icon next to the filename according to its extension:  diff --git a/doc/user/project/repository/web_editor.md b/doc/user/project/repository/web_editor.md index 24bfeee5e7f2000619ef2765185e60fe05e0c6d5..b9477da39373e052b372837b9cf4fd23721194c1 100644 --- a/doc/user/project/repository/web_editor.md +++ b/doc/user/project/repository/web_editor.md @@ -19,7 +19,7 @@ From a project's files page, click the '+' button to the right of the branch sel Choose **New file** from the dropdown.  -Enter a file name in the **Filename** box. Then, add file content in the editor +Enter a filename in the **Filename** box. Then, add file content in the editor area. Add a descriptive commit message and choose a branch. The branch field will default to the branch you were viewing in the file browser. If you enter a new branch name, a checkbox will appear, allowing you to start a new merge diff --git a/doc/user/snippets.md b/doc/user/snippets.md index 33aa0bd253b7ff0401122b5b1835d1f8206d1abd..5dd93f9e9dbada540b6a0793995c5345b01f4f96 100644 --- a/doc/user/snippets.md +++ b/doc/user/snippets.md @@ -53,7 +53,7 @@ From there, add the **Title**, **Description**, and a **File** name with the appropriate extension (for example, `example.rb`, `index.html`). WARNING: -Make sure to add the file name to get code highlighting and to avoid this +Make sure to add the filename to get code highlighting and to avoid this [copy-pasting bug](https://gitlab.com/gitlab-org/gitlab/-/issues/22870). ## Versioned Snippets @@ -72,7 +72,7 @@ it or creating other branches is not supported. Existing snippets will be automatically migrated in 13.0. Their current content will be saved as the initial commit to the snippets' repository. -### File names +### Filenames Snippets support syntax highlighting based on the filename and extension provided for them. While it is possible to submit a snippet @@ -122,7 +122,7 @@ To delete a file from your snippet through the GitLab UI: 1. Go to your snippet in the GitLab UI. 1. Click **Edit** in the top right. -1. Select **Delete file** alongside the file name of each file +1. Select **Delete file** alongside the filename of each file you wish to delete. 1. Click **Save changes**. @@ -221,6 +221,6 @@ Here's how an embedded snippet looks like: <script src="https://gitlab.com/gitlab-org/gitlab-foss/snippets/1717978.js"></script> -Embedded snippets are displayed with a header that shows the file name if it's defined, +Embedded snippets are displayed with a header that shows the filename if it's defined, the snippet size, a link to GitLab, and the actual snippet content. Actions in the header allow users to see the snippet in raw format and download it.