Commit 109cfd95 authored by Marcel Amirault's avatar Marcel Amirault 🇯🇵 Committed by Achilleas Pipinellis

Correct grammar (setup to set-up) in Docs

parent a4a7c531
Pipeline #30842075 passed with stages
in 5 minutes and 49 seconds
...@@ -191,7 +191,7 @@ instant how code changes impact your production environment. ...@@ -191,7 +191,7 @@ instant how code changes impact your production environment.
### User account ### User account
- [User account](user/profile/index.md): Manage your account - [User account](user/profile/index.md): Manage your account
- [Authentication](topics/authentication/index.md): Account security with two-factor authentication, setup your ssh keys and deploy keys for secure access to your projects. - [Authentication](topics/authentication/index.md): Account security with two-factor authentication, set up your ssh keys and deploy keys for secure access to your projects.
- [Profile settings](user/profile/index.md#profile-settings): Manage your profile settings, two factor authentication and more. - [Profile settings](user/profile/index.md#profile-settings): Manage your profile settings, two factor authentication and more.
- [User permissions](user/permissions.md): Learn what each role in a project (external/guest/reporter/developer/maintainer/owner) can do. - [User permissions](user/permissions.md): Learn what each role in a project (external/guest/reporter/developer/maintainer/owner) can do.
......
...@@ -132,7 +132,7 @@ main: ...@@ -132,7 +132,7 @@ main:
## Enables SSL certificate verification if encryption method is ## Enables SSL certificate verification if encryption method is
## "start_tls" or "simple_tls". Defaults to true since GitLab 10.0 for ## "start_tls" or "simple_tls". Defaults to true since GitLab 10.0 for
## security. This may break installations upon upgrade to 10.0, that did ## security. This may break installations upon upgrade to 10.0, that did
## not know their LDAP SSL certificates were not setup properly. ## not know their LDAP SSL certificates were not set up properly.
## ##
verify_certificates: true verify_certificates: true
......
...@@ -9,7 +9,7 @@ separate from the GitLab Omnibus package. ...@@ -9,7 +9,7 @@ separate from the GitLab Omnibus package.
If you use a cloud-managed service, or provide your own PostgreSQL instance: If you use a cloud-managed service, or provide your own PostgreSQL instance:
1. Setup PostgreSQL according to the 1. Set up PostgreSQL according to the
[database requirements document](../install/requirements.md#database). [database requirements document](../install/requirements.md#database).
1. Set up a `gitlab` username with a password of your choice. The `gitlab` user 1. Set up a `gitlab` username with a password of your choice. The `gitlab` user
needs privileges to create the `gitlabhq_production` database. needs privileges to create the `gitlabhq_production` database.
......
...@@ -13,7 +13,7 @@ Database Service (RDS) that runs PostgreSQL. ...@@ -13,7 +13,7 @@ Database Service (RDS) that runs PostgreSQL.
If you use a cloud-managed service, or provide your own PostgreSQL: If you use a cloud-managed service, or provide your own PostgreSQL:
1. Setup PostgreSQL according to the 1. Set up PostgreSQL according to the
[database requirements document](../../install/requirements.md#database). [database requirements document](../../install/requirements.md#database).
1. Set up a `gitlab` username with a password of your choice. The `gitlab` user 1. Set up a `gitlab` username with a password of your choice. The `gitlab` user
needs privileges to create the `gitlabhq_production` database. needs privileges to create the `gitlabhq_production` database.
......
...@@ -81,7 +81,7 @@ When a **Master** fails to respond, it's the application's responsibility ...@@ -81,7 +81,7 @@ When a **Master** fails to respond, it's the application's responsibility
(in our case GitLab) to handle timeout and reconnect (querying a **Sentinel** (in our case GitLab) to handle timeout and reconnect (querying a **Sentinel**
for a new **Master**). for a new **Master**).
To get a better understanding on how to correctly setup Sentinel, please read To get a better understanding on how to correctly set up Sentinel, please read
the [Redis Sentinel documentation](http://redis.io/topics/sentinel) first, as the [Redis Sentinel documentation](http://redis.io/topics/sentinel) first, as
failing to configure it correctly can lead to data loss or can bring your failing to configure it correctly can lead to data loss or can bring your
whole cluster down, invalidating the failover effort. whole cluster down, invalidating the failover effort.
...@@ -217,7 +217,7 @@ Pick the one that suits your needs. ...@@ -217,7 +217,7 @@ Pick the one that suits your needs.
and configure Sentinel, jump directly to the Sentinel section in the and configure Sentinel, jump directly to the Sentinel section in the
[Redis HA installation from source](redis_source.md#step-3-configuring-the-redis-sentinel-instances) documentation. [Redis HA installation from source](redis_source.md#step-3-configuring-the-redis-sentinel-instances) documentation.
- [Omnibus GitLab **Enterprise Edition** (EE) package][ee]: Both Redis and Sentinel - [Omnibus GitLab **Enterprise Edition** (EE) package][ee]: Both Redis and Sentinel
are bundled in the package, so you can use the EE package to setup the whole are bundled in the package, so you can use the EE package to set up the whole
Redis HA infrastructure (master, slave and Sentinel) which is described in Redis HA infrastructure (master, slave and Sentinel) which is described in
this document. this document.
- If you have installed GitLab using the Omnibus GitLab packages (CE or EE), - If you have installed GitLab using the Omnibus GitLab packages (CE or EE),
...@@ -228,7 +228,7 @@ Pick the one that suits your needs. ...@@ -228,7 +228,7 @@ Pick the one that suits your needs.
## Configuring Redis HA ## Configuring Redis HA
This is the section where we install and setup the new Redis instances. This is the section where we install and set up the new Redis instances.
> **Notes:** > **Notes:**
> - We assume that you have installed GitLab and all HA components from scratch. If you > - We assume that you have installed GitLab and all HA components from scratch. If you
...@@ -370,7 +370,7 @@ You must have at least `3` Redis Sentinel servers, and they need to ...@@ -370,7 +370,7 @@ You must have at least `3` Redis Sentinel servers, and they need to
be each in an independent machine. You can configure them in the same be each in an independent machine. You can configure them in the same
machines where you've configured the other Redis servers. machines where you've configured the other Redis servers.
With GitLab Enterprise Edition, you can use the Omnibus package to setup With GitLab Enterprise Edition, you can use the Omnibus package to set up
multiple machines with the Sentinel daemon. multiple machines with the Sentinel daemon.
--- ---
...@@ -535,7 +535,7 @@ In this example we consider that all servers have an internal network ...@@ -535,7 +535,7 @@ In this example we consider that all servers have an internal network
interface with IPs in the `10.0.0.x` range, and that they can connect interface with IPs in the `10.0.0.x` range, and that they can connect
to each other using these IPs. to each other using these IPs.
In a real world usage, you would also setup firewall rules to prevent In a real world usage, you would also set up firewall rules to prevent
unauthorized access from other machines and block traffic from the unauthorized access from other machines and block traffic from the
outside (Internet). outside (Internet).
......
...@@ -24,7 +24,7 @@ the Omnibus Redis HA documentation. ...@@ -24,7 +24,7 @@ the Omnibus Redis HA documentation.
## Configuring your own Redis server ## Configuring your own Redis server
This is the section where we install and setup the new Redis instances. This is the section where we install and set up the new Redis instances.
### Prerequisites ### Prerequisites
...@@ -204,7 +204,7 @@ In this example we consider that all servers have an internal network ...@@ -204,7 +204,7 @@ In this example we consider that all servers have an internal network
interface with IPs in the `10.0.0.x` range, and that they can connect interface with IPs in the `10.0.0.x` range, and that they can connect
to each other using these IPs. to each other using these IPs.
In a real world usage, you would also setup firewall rules to prevent In a real world usage, you would also set up firewall rules to prevent
unauthorized access from other machines, and block traffic from the unauthorized access from other machines, and block traffic from the
outside ([Internet][it]). outside ([Internet][it]).
......
...@@ -31,7 +31,7 @@ uploading user SSH keys to GitLab entirely. ...@@ -31,7 +31,7 @@ uploading user SSH keys to GitLab entirely.
## Setting up SSH certificate lookup via GitLab Shell ## Setting up SSH certificate lookup via GitLab Shell
How to fully setup SSH certificates is outside the scope of this How to fully set up SSH certificates is outside the scope of this
document. See [OpenSSH's document. See [OpenSSH's
PROTOCOL.certkeys](https://cvsweb.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL.certkeys?annotate=HEAD) PROTOCOL.certkeys](https://cvsweb.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL.certkeys?annotate=HEAD)
for how it works, and e.g. [RedHat's documentation about for how it works, and e.g. [RedHat's documentation about
...@@ -132,7 +132,7 @@ message about this being an invalid user. ...@@ -132,7 +132,7 @@ message about this being an invalid user.
## Interaction with the `authorized_keys` file ## Interaction with the `authorized_keys` file
SSH certificates can be used in conjunction with the `authorized_keys` SSH certificates can be used in conjunction with the `authorized_keys`
file, and if setup as configured above the `authorized_keys` file will file, and if set up as configured above the `authorized_keys` file will
still serve as a fallback. still serve as a fallback.
This is because if the `AuthorizedPrincipalsCommand` can't This is because if the `AuthorizedPrincipalsCommand` can't
......
...@@ -56,7 +56,7 @@ Runs the following rake tasks: ...@@ -56,7 +56,7 @@ Runs the following rake tasks:
- `gitlab:sidekiq:check` - `gitlab:sidekiq:check`
- `gitlab:app:check` - `gitlab:app:check`
It will check that each component was setup according to the installation guide and suggest fixes for issues found. It will check that each component was set up according to the installation guide and suggest fixes for issues found.
You may also have a look at our Trouble Shooting Guides: You may also have a look at our Trouble Shooting Guides:
- [Trouble Shooting Guide (GitLab)](http://docs.gitlab.com/ee/README.html#troubleshooting) - [Trouble Shooting Guide (GitLab)](http://docs.gitlab.com/ee/README.html#troubleshooting)
......
...@@ -5,7 +5,7 @@ replying to notification emails. ...@@ -5,7 +5,7 @@ replying to notification emails.
## Requirement ## Requirement
Make sure [incoming email](incoming_email.md) is setup. Make sure [incoming email](incoming_email.md) is set up.
## How it works? ## How it works?
......
...@@ -245,7 +245,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo ...@@ -245,7 +245,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
220 gitlab.example.com ESMTP Postfix (Ubuntu) 220 gitlab.example.com ESMTP Postfix (Ubuntu)
``` ```
If you get a `Connection refused` error instead, make sure your firewall is setup to allow inbound traffic on port 25. If you get a `Connection refused` error instead, make sure your firewall is set up to allow inbound traffic on port 25.
1. Send the `incoming` user a dummy email to test SMTP, by entering the following into the SMTP prompt: 1. Send the `incoming` user a dummy email to test SMTP, by entering the following into the SMTP prompt:
......
...@@ -193,7 +193,7 @@ are listed in the descriptions of the relevant settings. ...@@ -193,7 +193,7 @@ are listed in the descriptions of the relevant settings.
| `metrics_port` | integer | required by: `metrics_enabled` | The UDP port to use for connecting to InfluxDB. | | `metrics_port` | integer | required by: `metrics_enabled` | The UDP port to use for connecting to InfluxDB. |
| `metrics_sample_interval` | integer | required by: `metrics_enabled` | The sampling interval in seconds. | | `metrics_sample_interval` | integer | required by: `metrics_enabled` | The sampling interval in seconds. |
| `metrics_timeout` | integer | required by: `metrics_enabled` | The amount of seconds after which InfluxDB will time out. | | `metrics_timeout` | integer | required by: `metrics_enabled` | The amount of seconds after which InfluxDB will time out. |
| `mirror_available` | boolean | no | Allow mirrors to be setup for projects. If disabled, only admins will be able to setup mirrors in projects. | | `mirror_available` | boolean | no | Allow mirrors to be set up for projects. If disabled, only admins will be able to set up mirrors in projects. |
| `pages_domain_verification_enabled` | boolean | no | Require users to prove ownership of custom domains. Domain verification is an essential security measure for public GitLab sites. Users are required to demonstrate they control a domain before it is enabled. | | `pages_domain_verification_enabled` | boolean | no | Require users to prove ownership of custom domains. Domain verification is an essential security measure for public GitLab sites. Users are required to demonstrate they control a domain before it is enabled. |
| `password_authentication_enabled_for_git` | boolean | no | Enable authentication for Git over HTTP(S) via a GitLab account password. Default is `true`. | | `password_authentication_enabled_for_git` | boolean | no | Enable authentication for Git over HTTP(S) via a GitLab account password. Default is `true`. |
| `password_authentication_enabled_for_web` | boolean | no | Enable authentication for the web interface via a GitLab account password. Default is `true`. | | `password_authentication_enabled_for_web` | boolean | no | Enable authentication for the web interface via a GitLab account password. Default is `true`. |
......
...@@ -11,7 +11,7 @@ We made a minimal [Ruby application](https://gitlab.com/gitlab-examples/minimal- ...@@ -11,7 +11,7 @@ We made a minimal [Ruby application](https://gitlab.com/gitlab-examples/minimal-
Let’s start by forking our sample application. Go to [the project page](https://gitlab.com/gitlab-examples/minimal-ruby-app) and press the `Fork` button. Soon you should have a project under your namespace with the necessary files. Let’s start by forking our sample application. Go to [the project page](https://gitlab.com/gitlab-examples/minimal-ruby-app) and press the `Fork` button. Soon you should have a project under your namespace with the necessary files.
## Setup your own cluster on Google Kubernetes Engine ## Set up your own cluster on Google Kubernetes Engine
If you do not already have a Google Cloud account, create one at https://console.cloud.google.com. If you do not already have a Google Cloud account, create one at https://console.cloud.google.com.
...@@ -71,7 +71,7 @@ Use this IP address to configure your DNS. This part heavily depends on your pre ...@@ -71,7 +71,7 @@ Use this IP address to configure your DNS. This part heavily depends on your pre
Use `nslookup minimal-ruby-app-staging.<yourdomain>` to confirm that domain is assigned to the cluster IP. Use `nslookup minimal-ruby-app-staging.<yourdomain>` to confirm that domain is assigned to the cluster IP.
## Setup Auto Deploy ## Set up Auto Deploy
Visit the home page of your GitLab.com project and press "Set up Auto Deploy" button. Visit the home page of your GitLab.com project and press "Set up Auto Deploy" button.
......
...@@ -370,7 +370,7 @@ review_app: ...@@ -370,7 +370,7 @@ review_app:
url: https://$CI_COMMIT_REF_SLUG.example.com url: https://$CI_COMMIT_REF_SLUG.example.com
``` ```
It is assumed that the user has already setup NGINX and GitLab Runner in the It is assumed that the user has already set up NGINX and GitLab Runner in the
server this job will run on. server this job will run on.
>**Note:** >**Note:**
......
...@@ -520,7 +520,7 @@ a lot of breathing room in quickly getting changes to players. ...@@ -520,7 +520,7 @@ a lot of breathing room in quickly getting changes to players.
Here are some ideas to further investigate that can speed up or improve your pipeline: Here are some ideas to further investigate that can speed up or improve your pipeline:
- [Yarn](https://yarnpkg.com) instead of npm - [Yarn](https://yarnpkg.com) instead of npm
- Setup a custom [Docker](../../../ci/docker/using_docker_images.md#define-image-and-services-from-gitlab-ci-yml) image that can preload dependencies and tools (like AWS CLI) - Set up a custom [Docker](../../../ci/docker/using_docker_images.md#define-image-and-services-from-gitlab-ci-yml) image that can preload dependencies and tools (like AWS CLI)
- Forward a [custom domain](http://docs.aws.amazon.com/AmazonS3/latest/dev/website-hosting-custom-domain-walkthrough.html) to your game's S3 static website - Forward a [custom domain](http://docs.aws.amazon.com/AmazonS3/latest/dev/website-hosting-custom-domain-walkthrough.html) to your game's S3 static website
- Combine jobs if you find it unnecessary for a small project - Combine jobs if you find it unnecessary for a small project
- Avoid the queues and set up your own [custom GitLab CI/CD runner](https://about.gitlab.com/2016/03/01/gitlab-runner-with-docker/) - Avoid the queues and set up your own [custom GitLab CI/CD runner](https://about.gitlab.com/2016/03/01/gitlab-runner-with-docker/)
...@@ -13,7 +13,7 @@ date: 2017-08-31 ...@@ -13,7 +13,7 @@ date: 2017-08-31
GitLab features our applications with Continuous Integration, and it is possible to easily deploy the new code changes to the production server whenever we want. GitLab features our applications with Continuous Integration, and it is possible to easily deploy the new code changes to the production server whenever we want.
In this tutorial, we'll show you how to initialize a [Laravel](http://laravel.com/) application and setup our [Envoy](https://laravel.com/docs/envoy) tasks, then we'll jump into see how to test and deploy it with [GitLab CI/CD](../README.md) via [Continuous Delivery](https://about.gitlab.com/2016/08/05/continuous-integration-delivery-and-deployment-with-gitlab/). In this tutorial, we'll show you how to initialize a [Laravel](http://laravel.com/) application and set up our [Envoy](https://laravel.com/docs/envoy) tasks, then we'll jump into see how to test and deploy it with [GitLab CI/CD](../README.md) via [Continuous Delivery](https://about.gitlab.com/2016/08/05/continuous-integration-delivery-and-deployment-with-gitlab/).
We assume you have a basic experience with Laravel, Linux servers, We assume you have a basic experience with Laravel, Linux servers,
and you know how to use GitLab. and you know how to use GitLab.
...@@ -23,7 +23,7 @@ It has a great community with a [fantastic documentation](https://laravel.com/do ...@@ -23,7 +23,7 @@ It has a great community with a [fantastic documentation](https://laravel.com/do
Aside from the usual routing, controllers, requests, responses, views, and (blade) templates, out of the box Laravel provides plenty of additional services such as cache, events, localization, authentication and many others. Aside from the usual routing, controllers, requests, responses, views, and (blade) templates, out of the box Laravel provides plenty of additional services such as cache, events, localization, authentication and many others.
We will use [Envoy](https://laravel.com/docs/master/envoy) as an SSH task runner based on PHP. We will use [Envoy](https://laravel.com/docs/master/envoy) as an SSH task runner based on PHP.
It uses a clean, minimal [Blade syntax](https://laravel.com/docs/blade) to setup tasks that can run on remote servers, such as, cloning your project from the repository, installing the Composer dependencies, and running [Artisan commands](https://laravel.com/docs/artisan). It uses a clean, minimal [Blade syntax](https://laravel.com/docs/blade) to set up tasks that can run on remote servers, such as, cloning your project from the repository, installing the Composer dependencies, and running [Artisan commands](https://laravel.com/docs/artisan).
## Initialize our Laravel app on GitLab ## Initialize our Laravel app on GitLab
...@@ -372,7 +372,7 @@ At the end, our `Envoy.blade.php` file will look like this: ...@@ -372,7 +372,7 @@ At the end, our `Envoy.blade.php` file will look like this:
One more thing we should do before any deployment is to manually copy our application `storage` folder to the `/var/www/app` directory on the server for the first time. One more thing we should do before any deployment is to manually copy our application `storage` folder to the `/var/www/app` directory on the server for the first time.
You might want to create another Envoy task to do that for you. You might want to create another Envoy task to do that for you.
We also create the `.env` file in the same path to setup our production environment variables for Laravel. We also create the `.env` file in the same path to set up our production environment variables for Laravel.
These are persistent data and will be shared to every new release. These are persistent data and will be shared to every new release.
Now, we would need to deploy our app by running `envoy run deploy`, but it won't be necessary since GitLab can handle that for us with CI's [environments](../../environments.md), which will be described [later](#setting-up-gitlab-ci-cd) in this tutorial. Now, we would need to deploy our app by running `envoy run deploy`, but it won't be necessary since GitLab can handle that for us with CI's [environments](../../environments.md), which will be described [later](#setting-up-gitlab-ci-cd) in this tutorial.
...@@ -587,7 +587,7 @@ unit_test: ...@@ -587,7 +587,7 @@ unit_test:
script: script:
# Install app dependencies # Install app dependencies
- composer install - composer install
# Setup .env # Set up .env
- cp .env.example .env - cp .env.example .env
# Generate an environment key # Generate an environment key
- php artisan key:generate - php artisan key:generate
......
...@@ -199,7 +199,7 @@ pecl install <extension> ...@@ -199,7 +199,7 @@ pecl install <extension>
``` ```
It's not advised to add this to `.gitlab-ci.yml`. You should execute this It's not advised to add this to `.gitlab-ci.yml`. You should execute this
command once, only to setup the build environment. command once, only to set up the build environment.
## Extend your tests ## Extend your tests
......
...@@ -29,7 +29,7 @@ are: ...@@ -29,7 +29,7 @@ are:
- **Specific Runners** are useful for jobs that have special requirements or for - **Specific Runners** are useful for jobs that have special requirements or for
projects with a specific demand. If a job has certain requirements, you can set projects with a specific demand. If a job has certain requirements, you can set
up the specific Runner with this in mind, while not having to do this for all up the specific Runner with this in mind, while not having to do this for all
Runners. For example, if you want to deploy a certain project, you can setup Runners. For example, if you want to deploy a certain project, you can set up
a specific Runner to have the right credentials for this. The [usage of tags](#using-tags) a specific Runner to have the right credentials for this. The [usage of tags](#using-tags)
may be useful in this case. Specific Runners process jobs using a [FIFO] queue. may be useful in this case. Specific Runners process jobs using a [FIFO] queue.
- **Group Runners** are useful when you have multiple projects under one group - **Group Runners** are useful when you have multiple projects under one group
...@@ -222,7 +222,7 @@ should keep in mind. ...@@ -222,7 +222,7 @@ should keep in mind.
### Using tags ### Using tags
You must setup a Runner to be able to run all the different types of jobs You must set up a Runner to be able to run all the different types of jobs
that it may encounter on the projects it's shared over. This would be that it may encounter on the projects it's shared over. This would be
problematic for large amounts of projects, if it wasn't for tags. problematic for large amounts of projects, if it wasn't for tags.
...@@ -298,7 +298,7 @@ and using more secure [Runner Executors](https://docs.gitlab.com/runner/executor ...@@ -298,7 +298,7 @@ and using more secure [Runner Executors](https://docs.gitlab.com/runner/executor
### Forks ### Forks
Whenever a project is forked, it copies the settings of the jobs that relate Whenever a project is forked, it copies the settings of the jobs that relate
to it. This means that if you have shared Runners setup for a project and to it. This means that if you have shared Runners set up for a project and
someone forks that project, the shared Runners will also serve jobs of this someone forks that project, the shared Runners will also serve jobs of this
project. project.
......
...@@ -7,7 +7,7 @@ description: 'Learn how to contribute to GitLab.' ...@@ -7,7 +7,7 @@ description: 'Learn how to contribute to GitLab.'
## Get started! ## Get started!
- Setup GitLab's development environment with [GitLab Development Kit (GDK)](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/README.md) - Set up GitLab's development environment with [GitLab Development Kit (GDK)](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/README.md)
- [GitLab contributing guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md) - [GitLab contributing guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md)
- [Architecture](architecture.md) of GitLab - [Architecture](architecture.md) of GitLab
- [Rake tasks](rake_tasks.md) for development - [Rake tasks](rake_tasks.md) for development
......
...@@ -63,7 +63,7 @@ EE version of your CE merge request. ...@@ -63,7 +63,7 @@ EE version of your CE merge request.
For each commit (except on `master`), the `ee_compat_check` CI job tries to For each commit (except on `master`), the `ee_compat_check` CI job tries to
detect if the current branch's changes will conflict during the CE->EE merge. detect if the current branch's changes will conflict during the CE->EE merge.
The job reports what files are conflicting and how to setup a merge request The job reports what files are conflicting and how to set up a merge request
against EE. against EE.
#### How the job works #### How the job works
......
...@@ -224,7 +224,7 @@ on those issues. Please select someone with relevant experience from the ...@@ -224,7 +224,7 @@ on those issues. Please select someone with relevant experience from the
the commit history for the affected files to find someone. the commit history for the affected files to find someone.
We also use [GitLab Triage] to automate some triaging policies. This is We also use [GitLab Triage] to automate some triaging policies. This is
currently setup as a [scheduled pipeline] running on [quality/triage-ops] currently set up as a [scheduled pipeline] running on [quality/triage-ops]
project. project.
[described in our handbook]: https://about.gitlab.com/handbook/engineering/issue-triage/ [described in our handbook]: https://about.gitlab.com/handbook/engineering/issue-triage/
......
...@@ -33,7 +33,7 @@ If your test DB is giving you problems, it is safe to nuke it because it doesn't ...@@ -33,7 +33,7 @@ If your test DB is giving you problems, it is safe to nuke it because it doesn't
- `bundle exec rake db:migrate RAILS_ENV=development`: Execute any pending migrations that you may have picked up from a MR - `bundle exec rake db:migrate RAILS_ENV=development`: Execute any pending migrations that you may have picked up from a MR
- `bundle exec rake db:migrate:status RAILS_ENV=development`: Check if all migrations are `up` or `down` - `bundle exec rake db:migrate:status RAILS_ENV=development`: Check if all migrations are `up` or `down`
- `bundle exec rake db:migrate:down VERSION=20170926203418 RAILS_ENV=development`: Tear down a migration - `bundle exec rake db:migrate:down VERSION=20170926203418 RAILS_ENV=development`: Tear down a migration
- `bundle exec rake db:migrate:up VERSION=20170926203418 RAILS_ENV=development`: Setup a migration - `bundle exec rake db:migrate:up VERSION=20170926203418 RAILS_ENV=development`: Set up a migration
- `bundle exec rake db:migrate:redo VERSION=20170926203418 RAILS_ENV=development`: Re-run a specific migration - `bundle exec rake db:migrate:redo VERSION=20170926203418 RAILS_ENV=development`: Re-run a specific migration
......
...@@ -60,7 +60,7 @@ as long as it's contained in the same module; that is, no other modules or ...@@ -60,7 +60,7 @@ as long as it's contained in the same module; that is, no other modules or
objects are touching them, then it would be an acceptable use. objects are touching them, then it would be an acceptable use.
We especially allow the case where a single instance variable is used with We especially allow the case where a single instance variable is used with
`||=` to setup the value. This would look like: `||=` to set up the value. This would look like:
``` ruby ``` ruby
module M module M
......
# Rake tasks for developers # Rake tasks for developers
## Setup db with developer seeds ## Set up db with developer seeds
Note that if your db user does not have advanced privileges you must create the db manually before running this command. Note that if your db user does not have advanced privileges you must create the db manually before running this command.
......
...@@ -154,7 +154,7 @@ He credits himself as being entirely responsible for moving his company to GitLa ...@@ -154,7 +154,7 @@ He credits himself as being entirely responsible for moving his company to GitLa
#### Updating to the latest release #### Updating to the latest release
Matthieu introduced his company to GitLab. He is responsible for maintaining and managing the company's installation in addition to his day job. He feels updates are too frequent and he doesn't always have sufficient time to update GitLab. As a result, he's not up to date with releases. Matthieu introduced his company to GitLab. He is responsible for maintaining and managing the company's installation in addition to his day job. He feels updates are too frequent and he doesn't always have sufficient time to update GitLab. As a result, he's not up to date with releases.
Matthieu tried to set up automatic updates, however, as he isn't a Systems Administrator, he wasn't confident in his set-up. He feels he should be able to "upgrade without users even noticing" but hasn't figured out how to do this yet. Matthieu would like the "update process to be triggered from the Admin Panel, perhaps accompanied with a changelog and the option to skip updates." Matthieu tried to set up automatic updates, however, as he isn't a Systems Administrator, he wasn't confident in his setup. He feels he should be able to "upgrade without users even noticing" but hasn't figured out how to do this yet. Matthieu would like the "update process to be triggered from the Admin Panel, perhaps accompanied with a changelog and the option to skip updates."
Matthieu is looking for confirmation that his update procedure is "secure and efficient" so more tutorials related to this topic would be useful to him. Matthieu is looking for confirmation that his update procedure is "secure and efficient" so more tutorials related to this topic would be useful to him.
......
...@@ -74,7 +74,7 @@ The first items we need to configure are the basic settings of the underlying vi ...@@ -74,7 +74,7 @@ The first items we need to configure are the basic settings of the underlying vi
> **Note:** if you're unsure which authentication type to use, select **Password** > **Note:** if you're unsure which authentication type to use, select **Password**
1. If you chose **SSH public key** - enter your `SSH public key` into the field provided 1. If you chose **SSH public key** - enter your `SSH public key` into the field provided
_(read the [SSH documentation][GitLab-Docs-SSH] to learn more about how to setup SSH _(read the [SSH documentation][GitLab-Docs-SSH] to learn more about how to set up SSH
public keys)_ public keys)_
1. If you chose **Password** - enter the password you wish to use _(this is the password that you 1. If you chose **Password** - enter the password you wish to use _(this is the password that you
will use later in this tutorial to [SSH] into the VM, so make sure it's a strong password/passphrase)_ will use later in this tutorial to [SSH] into the VM, so make sure it's a strong password/passphrase)_
...@@ -154,7 +154,7 @@ on the Azure Dashboard (you may need to refresh the page): ...@@ -154,7 +154,7 @@ on the Azure Dashboard (you may need to refresh the page):
The new VM can also be accessed by clicking the `All resources` or `Virtual machines` icons in the The new VM can also be accessed by clicking the `All resources` or `Virtual machines` icons in the
Azure Portal sidebar navigation menu. Azure Portal sidebar navigation menu.
## Setup a domain name ## Set up a domain name
The VM will have a public IP address (static by default), but Azure allows us to assign a friendly The VM will have a public IP address (static by default), but Azure allows us to assign a friendly
DNS name to the VM, so let's go ahead and do that. DNS name to the VM, so let's go ahead and do that.
...@@ -296,7 +296,7 @@ homepage for the project: ...@@ -296,7 +296,7 @@ homepage for the project:
![GitLab - Empty Project](img/gitlab-project-home-empty.png) ![GitLab - Empty Project](img/gitlab-project-home-empty.png)
If you scroll further down the project's home page, you'll see some basic instructions on how to If you scroll further down the project's home page, you'll see some basic instructions on how to
setup a local clone of your new repository and push and pull from it: set up a local clone of your new repository and push and pull from it:
![GitLab - Empty Project - Basic Instructions](img/gitlab-project-home-instructions.png) ![GitLab - Empty Project - Basic Instructions](img/gitlab-project-home-instructions.png)
...@@ -347,7 +347,7 @@ If you're running [SSH] from the command-line (terminal), then type in the follo ...@@ -347,7 +347,7 @@ If you're running [SSH] from the command-line (terminal), then type in the follo
connect to your VM, substituting `username` and `your-azure-domain-name.com` for the correct values. connect to your VM, substituting `username` and `your-azure-domain-name.com` for the correct values.
Again, remember that your Azure VM domain name will be the one you Again, remember that your Azure VM domain name will be the one you
[setup previously in the tutorial](#set-up-a-domain-name). If you didn't setup a domain name for [set up previously in the tutorial](#set-up-a-domain-name). If you didn't set up a domain name for
your VM, you can use the IP address in its place in the following command: your VM, you can use the IP address in its place in the following command:
```bash ```bash
...@@ -401,7 +401,7 @@ is now showing **"up-to-date"**: ...@@ -401,7 +401,7 @@ is now showing **"up-to-date"**:
Naturally, we believe that GitLab is a great git repository tool. However, GitLab is a whole lot Naturally, we believe that GitLab is a great git repository tool. However, GitLab is a whole lot
more than that too. GitLab unifies issues, code review, CI and CD into a single UI, helping you to more than that too. GitLab unifies issues, code review, CI and CD into a single UI, helping you to
move faster from idea to production, and in this tutorial we showed you how quick and easy it is to move faster from idea to production, and in this tutorial we showed you how quick and easy it is to
setup and run your own instance of GitLab on Azure, Microsoft's cloud service. set up and run your own instance of GitLab on Azure, Microsoft's cloud service.
Azure is a great way to experiment with GitLab, and if you decide (as we hope) that GitLab is for Azure is a great way to experiment with GitLab, and if you decide (as we hope) that GitLab is for
you, you can continue to use Azure as your secure, scalable cloud provider or of course run GitLab you, you can continue to use Azure as your secure, scalable cloud provider or of course run GitLab
...@@ -424,7 +424,7 @@ Check out our other [Technical Articles][GitLab-Technical-Articles] or browse th ...@@ -424,7 +424,7 @@ Check out our other [Technical Articles][GitLab-Technical-Articles] or browse th
- [Azure - Properly Shutdown an Azure VM][Azure-Properly-Shutdown-VM] - [Azure - Properly Shutdown an Azure VM][Azure-Properly-Shutdown-VM]
- [SSH], [PuTTY] and [Using SSH in PuTTY][Using-SSH-In-Putty] - [SSH], [PuTTY] and [Using SSH in PuTTY][Using-SSH-In-Putty]
[Original-Blog-Post]: https://about.gitlab.com/2016/07/13/how-to-setup-a-gitlab-instance-on-microsoft-azure/ "How to Setup a GitLab Instance on Microsoft Azure" [Original-Blog-Post]: https://about.gitlab.com/2016/07/13/how-to-setup-a-gitlab-instance-on-microsoft-azure/ "How to Set up a GitLab Instance on Microsoft Azure"
[GitLab-Docs]: https://docs.gitlab.com/ce/README.html "GitLab Documentation" [GitLab-Docs]: https://docs.gitlab.com/ce/README.html "GitLab Documentation"
[GitLab-Technical-Articles]: https://docs.gitlab.com/ce/articles/index.html "GitLab Technical Articles" [GitLab-Technical-Articles]: https://docs.gitlab.com/ce/articles/index.html "GitLab Technical Articles"
[GitLab-Docs-SSH]: https://docs.gitlab.com/ce/ssh/README.html "GitLab Documentation: SSH" [GitLab-Docs-SSH]: https://docs.gitlab.com/ce/ssh/README.html "GitLab Documentation: SSH"
......
...@@ -79,7 +79,7 @@ After installation or upgrade, remember to [convert any new tables](#tables-and- ...@@ -79,7 +79,7 @@ After installation or upgrade, remember to [convert any new tables](#tables-and-
--- ---
GitLab 8.14 has introduced [a feature](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7420) requiring `utf8mb4` encoding to be supported in your GitLab MySQL Database, which is not the case if you have setup your database before GitLab 8.16. GitLab 8.14 has introduced [a feature](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7420) requiring `utf8mb4` encoding to be supported in your GitLab MySQL Database, which is not the case if you have set up your database before GitLab 8.16.
Follow the below instructions to ensure you use the most up to date requirements for your GitLab MySQL Database. Follow the below instructions to ensure you use the most up to date requirements for your GitLab MySQL Database.
......
...@@ -87,7 +87,7 @@ You can add this to your `~/.bash_profile` file to ensure the `docker` client us ...@@ -87,7 +87,7 @@ You can add this to your `~/.bash_profile` file to ensure the `docker` client us
+ Container name: `gitlab-test-8.10` + Container name: `gitlab-test-8.10`
+ GitLab version: **EE** `8.10.8-ee.0` + GitLab version: **EE** `8.10.8-ee.0`
##### Setup container settings ##### Set up container settings
``` ```
export SSH_PORT=2222 export SSH_PORT=2222
......
...@@ -515,7 +515,7 @@ Make GitLab start on boot: ...@@ -515,7 +515,7 @@ Make GitLab start on boot:
sudo update-rc.d gitlab defaults 21 sudo update-rc.d gitlab defaults 21
### Setup Logrotate ### Set up Logrotate
sudo cp lib/support/logrotate/gitlab /etc/logrotate.d/gitlab sudo cp lib/support/logrotate/gitlab /etc/logrotate.d/gitlab
......
...@@ -80,7 +80,7 @@ This will download the VirtualBox image and fire up the VM with some preconfigur ...@@ -80,7 +80,7 @@ This will download the VirtualBox image and fire up the VM with some preconfigur
values as you can see in the Vagrantfile. As you may have noticed, you need values as you can see in the Vagrantfile. As you may have noticed, you need
plenty of RAM (5GB in our example), so make sure you have enough. plenty of RAM (5GB in our example), so make sure you have enough.
Now that OpenShift is setup, let's see how the web console looks like. Now that OpenShift is set up, let's see how the web console looks like.
### Explore the OpenShift web console ### Explore the OpenShift web console
......
...@@ -124,5 +124,5 @@ To disable the relative URL: ...@@ -124,5 +124,5 @@ To disable the relative URL:
1. Follow the same as above starting from 2. and set up the 1. Follow the same as above starting from 2. and set up the
GitLab URL to one that doesn't contain a relative path. GitLab URL to one that doesn't contain a relative path.
[omnibus-rel]: http://docs.gitlab.com/omnibus/settings/configuration.html#configuring-a-relative-url-for-gitlab "How to setup relative URL in Omnibus GitLab" [omnibus-rel]: http://docs.gitlab.com/omnibus/settings/configuration.html#configuring-a-relative-url-for-gitlab "How to set up relative URL in Omnibus GitLab"
[restart gitlab]: ../administration/restart_gitlab.md#installations-from-source "How to restart GitLab" [restart gitlab]: ../administration/restart_gitlab.md#installations-from-source "How to restart GitLab"
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
GitLab supports [Google actions in email](https://developers.google.com/gmail/markup/actions/actions-overview). GitLab supports [Google actions in email](https://developers.google.com/gmail/markup/actions/actions-overview).
If correctly setup, emails that require an action will be marked in Gmail. If correctly set up, emails that require an action will be marked in Gmail.
![gmail_actions_button.png](img/gmail_action_buttons_for_gitlab.png) ![gmail_actions_button.png](img/gmail_action_buttons_for_gitlab.png)
......
...@@ -11,7 +11,7 @@ You can read more about it here: ...@@ -11,7 +11,7 @@ You can read more about it here:
## Enforcing 2FA for all users ## Enforcing 2FA for all users
Users on GitLab, can enable it without any admin's intervention. If you want to Users on GitLab, can enable it without any admin's intervention. If you want to
enforce everyone to setup 2FA, you can choose from two different ways: enforce everyone to set up 2FA, you can choose from two different ways:
1. Enforce on next login 1. Enforce on next login
2. Suggest on next login, but allow a grace period before enforcing. 2. Suggest on next login, but allow a grace period before enforcing.
......
...@@ -44,6 +44,6 @@ This page gathers all the resources for the topic **Authentication** within GitL ...@@ -44,6 +44,6 @@ This page gathers all the resources for the topic **Authentication** within GitL
- [Kanboard Plugin GitLab Authentication](https://kanboard.net/plugin/gitlab-auth) - [Kanboard Plugin GitLab Authentication](https://kanboard.net/plugin/gitlab-auth)
- [Jenkins GitLab OAuth Plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitLab+OAuth+Plugin) - [Jenkins GitLab OAuth Plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitLab+OAuth+Plugin)
- [Setup Gitlab CE with Active Directory authentication](https://www.caseylabs.com/setup-gitlab-ce-with-active-directory-authentication/) - [Set up Gitlab CE with Active Directory authentication](https://www.caseylabs.com/setup-gitlab-ce-with-active-directory-authentication/)
- [How to customize GitLab to support OpenID authentication](http://eric.van-der-vlist.com/blog/2013/11/23/how-to-customize-gitlab-to-support-openid-authentication/) - [How to customize GitLab to support OpenID authentication](http://eric.van-der-vlist.com/blog/2013/11/23/how-to-customize-gitlab-to-support-openid-authentication/)
- [Openshift - Configuring Authentication and User Agent](https://docs.openshift.org/latest/install_config/configuring_authentication.html#GitLab) - [Openshift - Configuring Authentication and User Agent](https://docs.openshift.org/latest/install_config/configuring_authentication.html#GitLab)
...@@ -395,7 +395,7 @@ Allow you to [organize issues](../../user/project/milestones/index.md) and merge ...@@ -395,7 +395,7 @@ Allow you to [organize issues](../../user/project/milestones/index.md) and merge
### Mirror Repositories ### Mirror Repositories
A project that is setup to automatically have its branches, tags, and commits [updated from an upstream repository](https://docs.gitlab.com/ee/workflow/repository_mirroring.html). This is useful when a repository you're interested in is located on a different server, and you want to be able to browse its content and activity using the familiar GitLab interface. A project that is set up to automatically have its branches, tags, and commits [updated from an upstream repository](https://docs.gitlab.com/ee/workflow/repository_mirroring.html). This is useful when a repository you're interested in is located on a different server, and you want to be able to browse its content and activity using the familiar GitLab interface.
### MIT License ### MIT License
...@@ -673,7 +673,7 @@ Version control is a system that records changes to a file or set of files over ...@@ -673,7 +673,7 @@ Version control is a system that records changes to a file or set of files over
### Virtual Private Cloud (VPC) ### Virtual Private Cloud (VPC)