Commit 8dee8b8e authored by Marcel Amirault's avatar Marcel Amirault Committed by Marcia Ramos

Update capitalization and backticks

Update capitalization and backtick use in /topic
/university and /workflow
parent b38b2a4d
...@@ -87,5 +87,5 @@ The following relate to Git Large File Storage: ...@@ -87,5 +87,5 @@ The following relate to Git Large File Storage:
- [Migrate an existing Git repo with Git LFS](migrate_to_git_lfs/index.md) - [Migrate an existing Git repo with Git LFS](migrate_to_git_lfs/index.md)
- [GitLab Git LFS user documentation](../../workflow/lfs/manage_large_binaries_with_git_lfs.md) - [GitLab Git LFS user documentation](../../workflow/lfs/manage_large_binaries_with_git_lfs.md)
- [GitLab Git LFS admin documentation](../../workflow/lfs/lfs_administration.md) - [GitLab Git LFS admin documentation](../../workflow/lfs/lfs_administration.md)
- [Git-Annex to Git-LFS migration guide](../../workflow/lfs/migrate_from_git_annex_to_git_lfs.md) - [git-annex to Git-LFS migration guide](../../workflow/lfs/migrate_from_git_annex_to_git_lfs.md)
- [Towards a production quality open source Git LFS server](https://about.gitlab.com/2015/08/13/towards-a-production-quality-open-source-git-lfs-server/) - [Towards a production quality open source Git LFS server](https://about.gitlab.com/2015/08/13/towards-a-production-quality-open-source-git-lfs-server/)
...@@ -102,7 +102,8 @@ enabled on the Git server: ...@@ -102,7 +102,8 @@ enabled on the Git server:
1. *Create a new Git repository and fetch.* Support for `--filter=sparse:oid` 1. *Create a new Git repository and fetch.* Support for `--filter=sparse:oid`
using the clone command is incomplete, so we will emulate the clone command using the clone command is incomplete, so we will emulate the clone command
by hand, using `git init` and `git fetch`. Follow by hand, using `git init` and `git fetch`. Follow
[gitaly#1769](https://gitlab.com/gitlab-org/gitaly/issues/1769) for updates. [issue tracking support for `--filter=sparse:oid`](https://gitlab.com/gitlab-org/git/issues/4)
for updates.
```bash ```bash
# Create a new directory for the Git repository # Create a new directory for the Git repository
...@@ -133,7 +134,7 @@ enabled on the Git server: ...@@ -133,7 +134,7 @@ enabled on the Git server:
1. **Sparse checkout** must be enabled and configured to prevent objects from 1. **Sparse checkout** must be enabled and configured to prevent objects from
other paths being downloaded automatically when checking out branches. Follow other paths being downloaded automatically when checking out branches. Follow
[gitaly#1765](https://gitlab.com/gitlab-org/gitaly/issues/1765) for updates. [issue proposing automating sparse checkouts](https://gitlab.com/gitlab-org/git/issues/5) for updates.
```bash ```bash
# Enable sparse checkout # Enable sparse checkout
......
...@@ -8,7 +8,7 @@ Sometimes things don't work the way they should or as you might expect when ...@@ -8,7 +8,7 @@ Sometimes things don't work the way they should or as you might expect when
you're using Git. Here are some tips on troubleshooting and resolving issues you're using Git. Here are some tips on troubleshooting and resolving issues
with Git. with Git.
## Broken pipe errors on git push ## Broken pipe errors on `git push`
'Broken pipe' errors can occur when attempting to push to a remote repository. 'Broken pipe' errors can occur when attempting to push to a remote repository.
When pushing you will usually see: When pushing you will usually see:
...@@ -68,7 +68,7 @@ ClientAliveInterval 60 ...@@ -68,7 +68,7 @@ ClientAliveInterval 60
ClientAliveCountMax 5 ClientAliveCountMax 5
``` ```
### Running a git repack ### Running a `git repack`
**If 'pack-objects' type errors are also being displayed**, you can try to **If 'pack-objects' type errors are also being displayed**, you can try to
run a `git repack` before attempting to push to the remote repository again: run a `git repack` before attempting to push to the remote repository again:
...@@ -110,7 +110,7 @@ MaxStartups 100 ...@@ -110,7 +110,7 @@ MaxStartups 100
Restart SSHD for the change to take effect. Restart SSHD for the change to take effect.
## Timeout during git push/pull ## Timeout during `git push` / `git pull`
If pulling/pushing from/to your repository ends up taking more than 50 seconds, If pulling/pushing from/to your repository ends up taking more than 50 seconds,
a timeout will be issued with a log of the number of operations performed a timeout will be issued with a log of the number of operations performed
......
...@@ -108,7 +108,7 @@ git reflog ...@@ -108,7 +108,7 @@ git reflog
### Check the Git history of a file ### Check the Git history of a file
The basic command to check the git history of a file: The basic command to check the Git history of a file:
```sh ```sh
git log <file> git log <file>
...@@ -147,7 +147,7 @@ gitk --follow <file> ...@@ -147,7 +147,7 @@ gitk --follow <file>
## Debugging ## Debugging
### Use a custom SSH key for a git command ### Use a custom SSH key for a Git command
```sh ```sh
GIT_SSH_COMMAND="ssh -i ~/.ssh/gitlabadmin" git <command> GIT_SSH_COMMAND="ssh -i ~/.ssh/gitlabadmin" git <command>
...@@ -183,7 +183,7 @@ git rebase -i master ...@@ -183,7 +183,7 @@ git rebase -i master
git rebase --continue git rebase --continue
``` ```
### Use git rerere ### Use `git rerere`
To _reuse_ recorded solutions to the same problems when repeated: To _reuse_ recorded solutions to the same problems when repeated:
......
...@@ -52,7 +52,7 @@ The GitLab University curriculum is composed of GitLab videos, screencasts, pres ...@@ -52,7 +52,7 @@ The GitLab University curriculum is composed of GitLab videos, screencasts, pres
### 1.5. Migrating from other Source Control ### 1.5. Migrating from other Source Control
1. [Migrating from BitBucket/Stash](../user/project/import/bitbucket.md) 1. [Migrating from Bitbucket/Stash](../user/project/import/bitbucket.md)
1. [Migrating from GitHub](../user/project/import/github.md) 1. [Migrating from GitHub](../user/project/import/github.md)
1. [Migrating from SVN](../user/project/import/svn.md) 1. [Migrating from SVN](../user/project/import/svn.md)
1. [Migrating from Fogbugz](../user/project/import/fogbugz.md) 1. [Migrating from Fogbugz](../user/project/import/fogbugz.md)
......
...@@ -6,6 +6,6 @@ comments: false ...@@ -6,6 +6,6 @@ comments: false
This page has been removed after an effort to ensure that all applicable GitLab-specific This page has been removed after an effort to ensure that all applicable GitLab-specific
terms are available in context on the relevant [GitLab Documentation](https://docs.gitlab.com/) terms are available in context on the relevant [GitLab Documentation](https://docs.gitlab.com/)
or [about.gitlab.com](https://about.gitlab.com/) pages. or <https://about.gitlab.com/> pages.
If you are looking for a definition of a specific term, please search these sites. If you are looking for a definition of a specific term, please search these sites.
...@@ -19,7 +19,7 @@ please submit a merge request to add an upcoming class, assign to ...@@ -19,7 +19,7 @@ please submit a merge request to add an upcoming class, assign to
1. Don't make materials that are needlessly specific to one group of people, try 1. Don't make materials that are needlessly specific to one group of people, try
to keep the wording broad and inclusive (don't make things for only GitLab Inc. to keep the wording broad and inclusive (don't make things for only GitLab Inc.
people, only interns, only customers, etc.). people, only interns, only customers, etc.).
1. To allow people to contribute all content should be in git. 1. To allow people to contribute all content should be in Git.
1. The content can go in a subdirectory under `/doc/university/`. 1. The content can go in a subdirectory under `/doc/university/`.
1. To make, view or modify the slides of the classes use [Deckset](http://www.decksetapp.com/) 1. To make, view or modify the slides of the classes use [Deckset](http://www.decksetapp.com/)
or [RevealJS](http://lab.hakim.se/reveal-js/). Do not use Powerpoint or Google or [RevealJS](http://lab.hakim.se/reveal-js/). Do not use Powerpoint or Google
......
...@@ -109,11 +109,11 @@ cd ~/workspace ...@@ -109,11 +109,11 @@ cd ~/workspace
- GitLab is an application to code, test and deploy. - GitLab is an application to code, test and deploy.
- Provides repository management with access controls, code reviews, - Provides repository management with access controls, code reviews,
issue tracking, Merge Requests, and other features. issue tracking, Merge Requests, and other features.
- The hosted version of GitLab is gitlab.com - The hosted version of GitLab is <https://gitlab.com>
### New Project ### New Project
- Sign in into your gitlab.com account - Sign in into your <https://gitlab.com> account
- Create a project - Create a project
- Choose to import from 'Any Repo by URL' and use <https://gitlab.com/gitlab-org/training-examples.git> - Choose to import from 'Any Repo by URL' and use <https://gitlab.com/gitlab-org/training-examples.git>
- On your machine clone the `training-examples` project - On your machine clone the `training-examples` project
...@@ -126,7 +126,7 @@ cd ~/workspace ...@@ -126,7 +126,7 @@ cd ~/workspace
1. Stage the file 1. Stage the file
1. Commit 1. Commit
1. Push the commit to the remote 1. Push the commit to the remote
1. View the git log 1. View the Git log
```shell ```shell
# Edit `edit_this_file.rb` # Edit `edit_this_file.rb`
...@@ -271,7 +271,7 @@ This will unstage the file but maintain the modifications. To revert the file ba ...@@ -271,7 +271,7 @@ This will unstage the file but maintain the modifications. To revert the file ba
git checkout -- <file> git checkout -- <file>
``` ```
To remove a file from disk and repo use 'git rm' and to rm a dir use the '-r' flag: To remove a file from disk and repo use `git rm` and to remove a directory use the `-r` flag:
```sh ```sh
git rm '*.txt' git rm '*.txt'
...@@ -338,7 +338,7 @@ git pull origin master ...@@ -338,7 +338,7 @@ git pull origin master
git push origin master git push origin master
``` ```
### git revert vs git reset ### `git revert` vs `git reset`
Reset removes the commit while revert removes the changes but leaves the commit Reset removes the commit while revert removes the changes but leaves the commit
Revert is safer considering we can revert a revert Revert is safer considering we can revert a revert
......
...@@ -65,7 +65,7 @@ Modified files that have been marked to go in the next commit. ...@@ -65,7 +65,7 @@ Modified files that have been marked to go in the next commit.
1. Stage the file 1. Stage the file
1. Commit 1. Commit
1. Push the commit to the remote 1. Push the commit to the remote
1. View the git log 1. View the Git log
```sh ```sh
# Edit `edit_this_file.rb` # Edit `edit_this_file.rb`
...@@ -79,5 +79,5 @@ git log ...@@ -79,5 +79,5 @@ git log
## Note ## Note
- git fetch vs pull - `git fetch` vs `git pull`
- Pull is git fetch + git merge - Pull is `git fetch` + `git merge`
...@@ -60,7 +60,7 @@ git push origin conflicts_branch -f ...@@ -60,7 +60,7 @@ git push origin conflicts_branch -f
## Note ## Note
- When to use 'git merge' and when to use 'git rebase' - When to use `git merge` and when to use `git rebase`
- Rebase when updating your branch with master - Rebase when updating your branch with master
- Merge when bringing changes from feature to master - Merge when bringing changes from feature to master
- Reference: <https://www.atlassian.com/git/tutorials/merging-vs-rebasing/> - Reference: <https://www.atlassian.com/git/tutorials/merging-vs-rebasing/>
...@@ -62,7 +62,7 @@ git push origin master ...@@ -62,7 +62,7 @@ git push origin master
## Note ## Note
- git revert vs git reset - `git revert` vs `git reset`
- Reset removes the commit while revert removes the changes but leaves the commit - Reset removes the commit while revert removes the changes but leaves the commit
- Revert is safer considering we can revert a revert - Revert is safer considering we can revert a revert
......
...@@ -4,7 +4,7 @@ comments: false ...@@ -4,7 +4,7 @@ comments: false
# Git Stash # Git Stash
We use git stash to store our changes when they are not ready to be committed We use `git stash` to store our changes when they are not ready to be committed
and we need to change to a different branch. and we need to change to a different branch.
- Stash: - Stash:
......
...@@ -16,7 +16,7 @@ comments: false ...@@ -16,7 +16,7 @@ comments: false
git checkout -- <file> git checkout -- <file>
``` ```
- To remove a file from disk and repo use 'git rm' and to rm a dir use the '-r' flag: - To remove a file from disk and repo use `git rm` and to remove a directory use the `-r` flag:
```sh ```sh
git rm '*.txt' git rm '*.txt'
......
...@@ -140,7 +140,7 @@ Modified files that have been marked to go in the next commit. ...@@ -140,7 +140,7 @@ Modified files that have been marked to go in the next commit.
1. Stage the file. 1. Stage the file.
1. Commit. 1. Commit.
1. Push the commit to the remote. 1. Push the commit to the remote.
1. View the git log. 1. View the Git log.
## Commands (committing) ## Commands (committing)
......
...@@ -53,7 +53,7 @@ to offload local hard disk R/W operations, and free up disk space significantly. ...@@ -53,7 +53,7 @@ to offload local hard disk R/W operations, and free up disk space significantly.
GitLab is tightly integrated with `Fog`, so you can refer to its [documentation](http://fog.io/about/provider_documentation.html) GitLab is tightly integrated with `Fog`, so you can refer to its [documentation](http://fog.io/about/provider_documentation.html)
to check which storage services can be integrated with GitLab. to check which storage services can be integrated with GitLab.
You can also use external object storage in a private local network. For example, You can also use external object storage in a private local network. For example,
[Minio](https://min.io/) is a standalone object storage service, is easy to set up, and works well with GitLab instances. [MinIO](https://min.io/) is a standalone object storage service, is easy to set up, and works well with GitLab instances.
GitLab provides two different options for the uploading mechanism: "Direct upload" and "Background upload". GitLab provides two different options for the uploading mechanism: "Direct upload" and "Background upload".
...@@ -93,7 +93,7 @@ Here is a configuration example with S3. ...@@ -93,7 +93,7 @@ Here is a configuration example with S3.
| `enable_signature_v4_streaming` | Set to true to enable HTTP chunked transfers with [AWS v4 signatures](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-streaming.html). Oracle Cloud S3 needs this to be false | true | | `enable_signature_v4_streaming` | Set to true to enable HTTP chunked transfers with [AWS v4 signatures](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-streaming.html). Oracle Cloud S3 needs this to be false | true |
| `region` | AWS region | us-east-1 | | `region` | AWS region | us-east-1 |
| `host` | S3 compatible host for when not using AWS, e.g. `localhost` or `storage.example.com` | s3.amazonaws.com | | `host` | S3 compatible host for when not using AWS, e.g. `localhost` or `storage.example.com` | s3.amazonaws.com |
| `endpoint` | Can be used when configuring an S3 compatible service such as [Minio](https://www.minio.io), by entering a URL such as `http://127.0.0.1:9000` | (optional) | | `endpoint` | Can be used when configuring an S3 compatible service such as [MinIO](https://www.minio.io), by entering a URL such as `http://127.0.0.1:9000` | (optional) |
| `path_style` | Set to true to use `host/bucket_name/object` style paths instead of `bucket_name.host/object`. Leave as false for AWS S3 | false | | `path_style` | Set to true to use `host/bucket_name/object` style paths instead of `bucket_name.host/object`. Leave as false for AWS S3 | false |
| `use_iam_profile` | Set to true to use IAM profile instead of access keys | false | `use_iam_profile` | Set to true to use IAM profile instead of access keys | false
...@@ -124,7 +124,7 @@ NOTE: **Note:** ...@@ -124,7 +124,7 @@ NOTE: **Note:**
Regardless of whether the container has public access enabled or disabled, Fog will Regardless of whether the container has public access enabled or disabled, Fog will
use the TempURL method to grant access to LFS objects. If you see errors in logs referencing use the TempURL method to grant access to LFS objects. If you see errors in logs referencing
instantiating storage with a temp-url-key, ensure that you have set they key properly instantiating storage with a temp-url-key, ensure that you have set they key properly
on the Rackspace API and in gitlab.rb. You can verify the value of the key Rackspace on the Rackspace API and in `gitlab.rb`. You can verify the value of the key Rackspace
has set by sending a GET request with token header to the service access endpoint URL has set by sending a GET request with token header to the service access endpoint URL
and comparing the output of the returned headers. and comparing the output of the returned headers.
...@@ -235,7 +235,7 @@ and [projects APIs](../../api/projects.md). ...@@ -235,7 +235,7 @@ and [projects APIs](../../api/projects.md).
## Troubleshooting: `Google::Apis::TransmissionError: execution expired` ## Troubleshooting: `Google::Apis::TransmissionError: execution expired`
If LFS integration is configred with Google Cloud Storage and background uploads (`background_upload: true` and `direct_upload: false`), If LFS integration is configred with Google Cloud Storage and background uploads (`background_upload: true` and `direct_upload: false`),
sidekiq workers may encouter this error. This is because the uploading timed out with very large files. Sidekiq workers may encouter this error. This is because the uploading timed out with very large files.
LFS files up to 6Gb can be uploaded without any extra steps, otherwise you need to use the following workaround. LFS files up to 6Gb can be uploaded without any extra steps, otherwise you need to use the following workaround.
```shell ```shell
......
...@@ -70,7 +70,7 @@ git add .gitattributes ...@@ -70,7 +70,7 @@ git add .gitattributes
``` ```
Cloning the repository works the same as before. Git automatically detects the Cloning the repository works the same as before. Git automatically detects the
LFS-tracked files and clones them via HTTP. If you performed the git clone LFS-tracked files and clones them via HTTP. If you performed the `git clone`
command with a SSH URL, you have to enter your GitLab credentials for HTTP command with a SSH URL, you have to enter your GitLab credentials for HTTP
authentication. authentication.
...@@ -172,7 +172,7 @@ Check if you have permissions to push to the project or fetch from the project. ...@@ -172,7 +172,7 @@ Check if you have permissions to push to the project or fetch from the project.
LFS object you are trying to push to the project or fetch from the project is not LFS object you are trying to push to the project or fetch from the project is not
available to the project anymore. Probably the object was removed from the server. available to the project anymore. Probably the object was removed from the server.
- Local git repository is using deprecated LFS API - Local Git repository is using deprecated LFS API
### Invalid status for `<url>` : 501 ### Invalid status for `<url>` : 501
...@@ -250,7 +250,7 @@ GitLab checks files to detect LFS pointers on push. If LFS pointers are detected ...@@ -250,7 +250,7 @@ GitLab checks files to detect LFS pointers on push. If LFS pointers are detected
Verify that LFS in installed locally and consider a manual push with `git lfs push --all`. Verify that LFS in installed locally and consider a manual push with `git lfs push --all`.
If you are storing LFS files outside of GitLab you can disable LFS on the project by setting `lfs_enabled: false` with the [projects api](../../api/projects.md#edit-project). If you are storing LFS files outside of GitLab you can disable LFS on the project by setting `lfs_enabled: false` with the [projects API](../../api/projects.md#edit-project).
### Hosting LFS objects externally ### Hosting LFS objects externally
......
...@@ -78,7 +78,7 @@ Below is the table of events users can be notified of: ...@@ -78,7 +78,7 @@ Below is the table of events users can be notified of:
| New email added | User | Security email, always sent. | | New email added | User | Security email, always sent. |
| Email changed | User | Security email, always sent. | | Email changed | User | Security email, always sent. |
| Password changed | User | Security email, always sent. | | Password changed | User | Security email, always sent. |
| New user created | User | Sent on user creation, except for omniauth (LDAP)| | New user created | User | Sent on user creation, except for OmniAuth (LDAP)|
| User added to project | User | Sent when user is added to project | | User added to project | User | Sent when user is added to project |
| Project access level changed | User | Sent when user project access level is changed | | Project access level changed | User | Sent when user project access level is changed |
| User added to group | User | Sent when user is added to group | | User added to group | User | Sent when user is added to group |
...@@ -150,7 +150,7 @@ Notification emails include headers that provide extra content about the notific ...@@ -150,7 +150,7 @@ Notification emails include headers that provide extra content about the notific
| X-GitLab-Pipeline-Id | Only in pipeline emails, the ID of the pipeline the notification is for | | X-GitLab-Pipeline-Id | Only in pipeline emails, the ID of the pipeline the notification is for |
| X-GitLab-Reply-Key | A unique token to support reply by email | | X-GitLab-Reply-Key | A unique token to support reply by email |
| X-GitLab-NotificationReason | The reason for being notified. "mentioned", "assigned", etc | | X-GitLab-NotificationReason | The reason for being notified. "mentioned", "assigned", etc |
| List-Id | The path of the project in a RFC 2919 mailing list identifier useful for email organization, for example, with GMail filters | | List-Id | The path of the project in a RFC 2919 mailing list identifier useful for email organization, for example, with Gmail filters |
#### X-GitLab-NotificationReason #### X-GitLab-NotificationReason
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment