Commit 12e3eff4 authored by Pascal Borreli's avatar Pascal Borreli Committed by Rémy Coutable

Fixed typos

parent 740f0bb1
...@@ -323,7 +323,7 @@ The prerequisites for a HA Redis setup are the following: ...@@ -323,7 +323,7 @@ The prerequisites for a HA Redis setup are the following:
# machines to connect to it. # machines to connect to it.
redis['port'] = 6379 redis['port'] = 6379
# The same password for Redeis authentication you set up for the master node. # The same password for Redis authentication you set up for the master node.
redis['password'] = 'redis-password-goes-here' redis['password'] = 'redis-password-goes-here'
# The IP of the master Redis node. # The IP of the master Redis node.
......
...@@ -107,7 +107,7 @@ For source installations the following settings are nested under `artifacts:` an ...@@ -107,7 +107,7 @@ For source installations the following settings are nested under `artifacts:` an
| Setting | Description | Default | | Setting | Description | Default |
|---------|-------------|---------| |---------|-------------|---------|
| `enabled` | Enable/disable object storage | `false` | | `enabled` | Enable/disable object storage | `false` |
| `remote_directory` | The bucket name where Artfacts will be stored| | | `remote_directory` | The bucket name where Artifacts will be stored| |
| `direct_upload` | Set to true to enable direct upload of Artifacts without the need of local shared storage. Option may be removed once we decide to support only single storage for all files. Currently only `Google` provider is supported | `false` | | `direct_upload` | Set to true to enable direct upload of Artifacts without the need of local shared storage. Option may be removed once we decide to support only single storage for all files. Currently only `Google` provider is supported | `false` |
| `background_upload` | Set to false to disable automatic upload. Option may be removed once upload is direct to S3 | `true` | | `background_upload` | Set to false to disable automatic upload. Option may be removed once upload is direct to S3 | `true` |
| `proxy_download` | Set to true to enable proxying all files served. Option allows to reduce egress traffic as this allows clients to download directly from remote storage instead of proxying all data | `false` | | `proxy_download` | Set to true to enable proxying all files served. Option allows to reduce egress traffic as this allows clients to download directly from remote storage instead of proxying all data | `false` |
...@@ -148,7 +148,7 @@ _The artifacts are stored by default in ...@@ -148,7 +148,7 @@ _The artifacts are stored by default in
``` ```
NOTE: For GitLab 9.4+, if you are using AWS IAM profiles, be sure to omit the NOTE: For GitLab 9.4+, if you are using AWS IAM profiles, be sure to omit the
AWS access key and secret acces key/value pairs. For example: AWS access key and secret access key/value pairs. For example:
```ruby ```ruby
gitlab_rails['artifacts_object_store_connection'] = { gitlab_rails['artifacts_object_store_connection'] = {
......
...@@ -46,7 +46,7 @@ In this experimental phase, only a few metrics are available: ...@@ -46,7 +46,7 @@ In this experimental phase, only a few metrics are available:
| redis_ping_latency_seconds | Gauge | 9.4 | Round trip time of the redis ping | | redis_ping_latency_seconds | Gauge | 9.4 | Round trip time of the redis ping |
| user_session_logins_total | Counter | 9.4 | Counter of how many users have logged in | | user_session_logins_total | Counter | 9.4 | Counter of how many users have logged in |
| filesystem_circuitbreaker_latency_seconds | Gauge | 9.5 | Time spent validating if a storage is accessible | | filesystem_circuitbreaker_latency_seconds | Gauge | 9.5 | Time spent validating if a storage is accessible |
| filesystem_circuitbreaker | Gauge | 9.5 | Wether or not the circuit for a certain shard is broken or not | | filesystem_circuitbreaker | Gauge | 9.5 | Whether or not the circuit for a certain shard is broken or not |
| circuitbreaker_storage_check_duration_seconds | Histogram | 10.3 | Time a single storage probe took | | circuitbreaker_storage_check_duration_seconds | Histogram | 10.3 | Time a single storage probe took |
## Metrics shared directory ## Metrics shared directory
......
...@@ -31,7 +31,7 @@ GitLab Shell provides a way to authorize SSH users via a fast, indexed lookup ...@@ -31,7 +31,7 @@ GitLab Shell provides a way to authorize SSH users via a fast, indexed lookup
to the GitLab database. GitLab Shell uses the fingerprint of the SSH key to to the GitLab database. GitLab Shell uses the fingerprint of the SSH key to
check whether the user is authorized to access GitLab. check whether the user is authorized to access GitLab.
Add the following to your `sshd_config` file. This is usuaully located at Add the following to your `sshd_config` file. This is usually located at
`/etc/ssh/sshd_config`, but it will be `/assets/sshd_config` if you're using `/etc/ssh/sshd_config`, but it will be `/assets/sshd_config` if you're using
Omnibus Docker: Omnibus Docker:
......
...@@ -104,7 +104,7 @@ _The uploads are stored by default in ...@@ -104,7 +104,7 @@ _The uploads are stored by default in
``` ```
>**Note:** >**Note:**
If you are using AWS IAM profiles, be sure to omit the AWS access key and secret acces key/value pairs. If you are using AWS IAM profiles, be sure to omit the AWS access key and secret access key/value pairs.
```ruby ```ruby
gitlab_rails['uploads_object_store_connection'] = { gitlab_rails['uploads_object_store_connection'] = {
......
...@@ -293,7 +293,7 @@ The following table gives an overview of how the API functions generally behave. ...@@ -293,7 +293,7 @@ The following table gives an overview of how the API functions generally behave.
| `GET` | Access one or more resources and return the result as JSON. | | `GET` | Access one or more resources and return the result as JSON. |
| `POST` | Return `201 Created` if the resource is successfully created and return the newly created resource as JSON. | | `POST` | Return `201 Created` if the resource is successfully created and return the newly created resource as JSON. |
| `GET` / `PUT` | Return `200 OK` if the resource is accessed or modified successfully. The (modified) result is returned as JSON. | | `GET` / `PUT` | Return `200 OK` if the resource is accessed or modified successfully. The (modified) result is returned as JSON. |
| `DELETE` | Returns `204 No Content` if the resuource was deleted successfully. | | `DELETE` | Returns `204 No Content` if the resource was deleted successfully. |
The following table shows the possible return codes for API requests. The following table shows the possible return codes for API requests.
......
...@@ -12,7 +12,7 @@ Badges support placeholders that will be replaced in real time in both the link ...@@ -12,7 +12,7 @@ Badges support placeholders that will be replaced in real time in both the link
- **%{default_branch}**: will be replaced by the project default branch. - **%{default_branch}**: will be replaced by the project default branch.
- **%{commit_sha}**: will be replaced by the last project's commit sha. - **%{commit_sha}**: will be replaced by the last project's commit sha.
Because these enpoints aren't inside a project's context, the information used to replace the placeholders will be Because these endpoints aren't inside a project's context, the information used to replace the placeholders will be
from the first group's project by creation date. If the group hasn't got any project the original URL with the placeholders will be returned. from the first group's project by creation date. If the group hasn't got any project the original URL with the placeholders will be returned.
## List all badges of a group ## List all badges of a group
......
...@@ -108,7 +108,7 @@ POST /projects/:id/pipeline_schedules ...@@ -108,7 +108,7 @@ POST /projects/:id/pipeline_schedules
| `description` | string | yes | The description of pipeline schedule | | `description` | string | yes | The description of pipeline schedule |
| `ref` | string | yes | The branch/tag name will be triggered | | `ref` | string | yes | The branch/tag name will be triggered |
| `cron ` | string | yes | The cron (e.g. `0 1 * * *`) ([Cron syntax](https://en.wikipedia.org/wiki/Cron)) | | `cron ` | string | yes | The cron (e.g. `0 1 * * *`) ([Cron syntax](https://en.wikipedia.org/wiki/Cron)) |
| `cron_timezone ` | string | no | The timezone supproted by `ActiveSupport::TimeZone` (e.g. `Pacific Time (US & Canada)`) (default: `'UTC'`) | | `cron_timezone ` | string | no | The timezone supported by `ActiveSupport::TimeZone` (e.g. `Pacific Time (US & Canada)`) (default: `'UTC'`) |
| `active ` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: `true`) | | `active ` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: `true`) |
```sh ```sh
...@@ -153,7 +153,7 @@ PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id ...@@ -153,7 +153,7 @@ PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id
| `description` | string | no | The description of pipeline schedule | | `description` | string | no | The description of pipeline schedule |
| `ref` | string | no | The branch/tag name will be triggered | | `ref` | string | no | The branch/tag name will be triggered |
| `cron ` | string | no | The cron (e.g. `0 1 * * *`) ([Cron syntax](https://en.wikipedia.org/wiki/Cron)) | | `cron ` | string | no | The cron (e.g. `0 1 * * *`) ([Cron syntax](https://en.wikipedia.org/wiki/Cron)) |
| `cron_timezone ` | string | no | The timezone supproted by `ActiveSupport::TimeZone` (e.g. `Pacific Time (US & Canada)`) or `TZInfo::Timezone` (e.g. `America/Los_Angeles`) | | `cron_timezone ` | string | no | The timezone supported by `ActiveSupport::TimeZone` (e.g. `Pacific Time (US & Canada)`) or `TZInfo::Timezone` (e.g. `America/Los_Angeles`) |
| `active ` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially. | | `active ` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially. |
```sh ```sh
......
...@@ -509,7 +509,7 @@ and unit tests, all running and deployed at every push to master - with shocking ...@@ -509,7 +509,7 @@ and unit tests, all running and deployed at every push to master - with shocking
Errors can be easily debugged through GitLab's build logs, and within minutes of a successful commit, Errors can be easily debugged through GitLab's build logs, and within minutes of a successful commit,
you can see the changes live on your game. you can see the changes live on your game.
Setting up Continous Integration and Continuous Deployment from the start with Dark Nova enables Setting up Continuous Integration and Continuous Deployment from the start with Dark Nova enables
rapid but stable development. We can easily test changes in a separate [environment](../../../ci/environments.md#introduction-to-environments-and-deployments), rapid but stable development. We can easily test changes in a separate [environment](../../../ci/environments.md#introduction-to-environments-and-deployments),
or multiple environments if needed. Balancing and updating a multiplayer game can be ongoing or multiple environments if needed. Balancing and updating a multiplayer game can be ongoing
and tedious, but having faith in a stable deployment with GitLab CI/CD allows and tedious, but having faith in a stable deployment with GitLab CI/CD allows
......
...@@ -30,7 +30,7 @@ and GitLab UI._ ...@@ -30,7 +30,7 @@ and GitLab UI._
Many components and concepts are similar to Ruby on Rails or Python's Django. High developer Many components and concepts are similar to Ruby on Rails or Python's Django. High developer
productivity and high application performance are only a few advantages on learning how to use it. productivity and high application performance are only a few advantages on learning how to use it.
Working on the MVC pattern, it's was designed to be modular and flexible. Easy to mantain a growing Working on the MVC pattern, it's was designed to be modular and flexible. Easy to maintain a growing
app is a plus. app is a plus.
Phoenix can run in any OS where Erlang is supported: Phoenix can run in any OS where Erlang is supported:
...@@ -48,7 +48,7 @@ Check the [Phoenix learning guide][phoenix-learning-guide] for more information. ...@@ -48,7 +48,7 @@ Check the [Phoenix learning guide][phoenix-learning-guide] for more information.
### What is Elixir? ### What is Elixir?
[Elixir][elixir-site] is a dynamic, functional language created to use all the maturity of Erlang [Elixir][elixir-site] is a dynamic, functional language created to use all the maturity of Erlang
(30 years old!) in these days, in an easy way. It has similarities with Ruby, specially on sintax, (30 years old!) in these days, in an easy way. It has similarities with Ruby, specially on syntax,
so Ruby developers are quite excited with the rapid growing of Elixir. A full-stack Ruby developer so Ruby developers are quite excited with the rapid growing of Elixir. A full-stack Ruby developer
can learn how to use Elixir and Phoenix in just a few weeks! can learn how to use Elixir and Phoenix in just a few weeks!
...@@ -162,7 +162,7 @@ productive, because every time we, or our co-workers push any code, GitLab CI/CD ...@@ -162,7 +162,7 @@ productive, because every time we, or our co-workers push any code, GitLab CI/CD
test the changes, telling us in realtime if anything goes wrong. test the changes, telling us in realtime if anything goes wrong.
Certainly, when our application starts to grow, we'll need more developers working on the same Certainly, when our application starts to grow, we'll need more developers working on the same
project and this process of building and testing can easely become a mess without proper management. project and this process of building and testing can easily become a mess without proper management.
That's also why GitLab CI/CD is so important to our application. Every time someone pushes its code to That's also why GitLab CI/CD is so important to our application. Every time someone pushes its code to
GitLab, we'll quickly know if their changes broke something or not. We don't need to stop everything GitLab, we'll quickly know if their changes broke something or not. We don't need to stop everything
we're doing to test manually and locally every change our team does. we're doing to test manually and locally every change our team does.
...@@ -237,7 +237,7 @@ Finished in 0.7 seconds ...@@ -237,7 +237,7 @@ Finished in 0.7 seconds
Randomized with seed 610000 Randomized with seed 610000
``` ```
Our test was successfull. It's time to push our files to GitLab. Our test was successful. It's time to push our files to GitLab.
## Configuring CI/CD Pipeline ## Configuring CI/CD Pipeline
...@@ -302,7 +302,7 @@ template** and select **Elixir**: ...@@ -302,7 +302,7 @@ template** and select **Elixir**:
``` ```
It's important to install `postgresql-client` to let GitLab CI/CD access PostgreSQL and create our It's important to install `postgresql-client` to let GitLab CI/CD access PostgreSQL and create our
database with the login information provided earlier. More important is to respect the identation, database with the login information provided earlier. More important is to respect the indentation,
to avoid syntax errors when running the build. to avoid syntax errors when running the build.
- And finally, we'll let `mix` session intact. - And finally, we'll let `mix` session intact.
...@@ -333,7 +333,7 @@ mix: ...@@ -333,7 +333,7 @@ mix:
- mix test - mix test
``` ```
For safety, we can check if we get any syntax errors before submiting this file to GitLab. Copy the For safety, we can check if we get any syntax errors before submitting this file to GitLab. Copy the
contents of `.gitlab-ci.yml` and paste it on [GitLab CI/CD Lint tool][ci-lint]. Please note that contents of `.gitlab-ci.yml` and paste it on [GitLab CI/CD Lint tool][ci-lint]. Please note that
this link will only work for logged in users. this link will only work for logged in users.
...@@ -384,7 +384,7 @@ working properly. ...@@ -384,7 +384,7 @@ working properly.
When we have a growing application with many developers working on it, or when we have an open When we have a growing application with many developers working on it, or when we have an open
source project being watched and contributed by the community, it is really important to have our source project being watched and contributed by the community, it is really important to have our
code permanently working. GitLab CI/CD is a time saving powerfull tool to help us mantain our code code permanently working. GitLab CI/CD is a time saving powerful tool to help us maintain our code
organized and working. organized and working.
As we could see in this post, GitLab CI/CD is really really easy to configure and use. We have [many As we could see in this post, GitLab CI/CD is really really easy to configure and use. We have [many
......
...@@ -551,7 +551,7 @@ You can find a full list of unsupported variables below: ...@@ -551,7 +551,7 @@ You can find a full list of unsupported variables below:
- `CI_DEPLOY_USER` - `CI_DEPLOY_USER`
- `CI_DEPLOY_PASSWORD` - `CI_DEPLOY_PASSWORD`
These variables are also not supported in a contex of a These variables are also not supported in a context of a
[dynamic environment name][dynamic-environments]. [dynamic environment name][dynamic-environments].
[ce-13784]: https://gitlab.com/gitlab-org/gitlab-ce/issues/13784 "Simple protection of CI secret variables" [ce-13784]: https://gitlab.com/gitlab-org/gitlab-ce/issues/13784 "Simple protection of CI secret variables"
......
...@@ -24,7 +24,7 @@ Some examples where background migrations can be useful: ...@@ -24,7 +24,7 @@ Some examples where background migrations can be useful:
* Migrating events from one table to multiple separate tables. * Migrating events from one table to multiple separate tables.
* Populating one column based on JSON stored in another column. * Populating one column based on JSON stored in another column.
* Migrating data that depends on the output of exernal services (e.g. an API). * Migrating data that depends on the output of external services (e.g. an API).
## Isolation ## Isolation
...@@ -46,7 +46,7 @@ See [Sidekiq best practices guidelines](https://github.com/mperham/sidekiq/wiki/ ...@@ -46,7 +46,7 @@ See [Sidekiq best practices guidelines](https://github.com/mperham/sidekiq/wiki/
for more details. for more details.
Make sure that in case that your migration job is going to be retried data Make sure that in case that your migration job is going to be retried data
integrity is guarateed. integrity is guaranteed.
## How It Works ## How It Works
......
...@@ -4,7 +4,7 @@ The documentation style guide defines the markup structure used in ...@@ -4,7 +4,7 @@ The documentation style guide defines the markup structure used in
GitLab documentation. Check the GitLab documentation. Check the
[documentation guidelines](writing_documentation.md) for general development instructions. [documentation guidelines](writing_documentation.md) for general development instructions.
Check the GitLab hanbook for the [writing styles guidelines](https://about.gitlab.com/handbook/communication/#writing-style-guidelines). Check the GitLab handbook for the [writing styles guidelines](https://about.gitlab.com/handbook/communication/#writing-style-guidelines).
## Text ## Text
...@@ -19,7 +19,7 @@ Check the GitLab hanbook for the [writing styles guidelines](https://about.gitla ...@@ -19,7 +19,7 @@ Check the GitLab hanbook for the [writing styles guidelines](https://about.gitla
- Unless there's a logical reason not to, add documents in alphabetical order - Unless there's a logical reason not to, add documents in alphabetical order
- Write in US English - Write in US English
- Use [single spaces][] instead of double spaces - Use [single spaces][] instead of double spaces
- Jump a line between different markups (e.g., after every paragraph, hearder, list, etc) - Jump a line between different markups (e.g., after every paragraph, header, list, etc)
- Capitalize "G" and "L" in GitLab - Capitalize "G" and "L" in GitLab
- Capitalize feature, products, and methods names. E.g.: GitLab Runner, Geo, - Capitalize feature, products, and methods names. E.g.: GitLab Runner, Geo,
Issue Boards, Git, Prometheus, Continuous Integration. Issue Boards, Git, Prometheus, Continuous Integration.
......
...@@ -279,7 +279,7 @@ end ...@@ -279,7 +279,7 @@ end
``` ```
In `lib/gitlab/visibility_level.rb` this method is used to return the In `lib/gitlab/visibility_level.rb` this method is used to return the
allowed visibilty levels: allowed visibility levels:
```ruby ```ruby
def levels_for_user(user = nil) def levels_for_user(user = nil)
......
...@@ -236,7 +236,7 @@ export class Foo { ...@@ -236,7 +236,7 @@ export class Foo {
} }
``` ```
On the other hand, if a class only needs to extend a third party/add event listeners in some specific cases, they should be initialized oustside of the constructor. On the other hand, if a class only needs to extend a third party/add event listeners in some specific cases, they should be initialized outside of the constructor.
1. Prefer `.map`, `.reduce` or `.filter` over `.forEach` 1. Prefer `.map`, `.reduce` or `.filter` over `.forEach`
A forEach will most likely cause side effects, it will be mutating the array being iterated. Prefer using `.map`, A forEach will most likely cause side effects, it will be mutating the array being iterated. Prefer using `.map`,
......
...@@ -84,7 +84,7 @@ The `RecordsUploads::Concern` concern will create an `Upload` entry for every fi ...@@ -84,7 +84,7 @@ The `RecordsUploads::Concern` concern will create an `Upload` entry for every fi
By including the `ObjectStorage::Concern` in the `GitlabUploader` derived class, you may enable the object storage for this uploader. To enable the object storage By including the `ObjectStorage::Concern` in the `GitlabUploader` derived class, you may enable the object storage for this uploader. To enable the object storage
in your uploader, you need to either 1) include `RecordsUpload::Concern` and prepend `ObjectStorage::Extension::RecordsUploads` or 2) mount the uploader and create a new field named `<mount>_store`. in your uploader, you need to either 1) include `RecordsUpload::Concern` and prepend `ObjectStorage::Extension::RecordsUploads` or 2) mount the uploader and create a new field named `<mount>_store`.
The `CarrierWave::Uploader#store_dir` is overriden to The `CarrierWave::Uploader#store_dir` is overridden to
- `GitlabUploader.base_dir` + `GitlabUploader.dynamic_segment` when the store is LOCAL - `GitlabUploader.base_dir` + `GitlabUploader.dynamic_segment` when the store is LOCAL
- `GitlabUploader.dynamic_segment` when the store is REMOTE (the bucket name is used to namespace) - `GitlabUploader.dynamic_segment` when the store is REMOTE (the bucket name is used to namespace)
......
...@@ -270,7 +270,7 @@ If there are merge conflicts in the `gitlab.pot` file, you can delete the file ...@@ -270,7 +270,7 @@ If there are merge conflicts in the `gitlab.pot` file, you can delete the file
and regenerate it using the same command. Confirm that you are not deleting any strings accidentally by looking over the diff. and regenerate it using the same command. Confirm that you are not deleting any strings accidentally by looking over the diff.
The command also updates the translation files for each language: `locale/*/gitlab.po` The command also updates the translation files for each language: `locale/*/gitlab.po`
These changes can be discarded, the languange files will be updated by Crowdin These changes can be discarded, the language files will be updated by Crowdin
automatically. automatically.
Discard all of them at once like this: Discard all of them at once like this:
......
...@@ -162,7 +162,7 @@ need for running complex operations to fetch the data. You should use Redis if ...@@ -162,7 +162,7 @@ need for running complex operations to fetch the data. You should use Redis if
data should be cached for a certain time period instead of the duration of the data should be cached for a certain time period instead of the duration of the
transaction. transaction.
For example, say you process multiple snippets of text containiner username For example, say you process multiple snippets of text containing username
mentions (e.g. `Hello @alice` and `How are you doing @alice?`). By caching the mentions (e.g. `Hello @alice` and `How are you doing @alice?`). By caching the
user objects for every username we can remove the need for running the same user objects for every username we can remove the need for running the same
query for every mention of `@alice`. query for every mention of `@alice`.
......
...@@ -30,7 +30,7 @@ example) at the end. ...@@ -30,7 +30,7 @@ example) at the end.
## Type Sizes ## Type Sizes
While the PostgreSQL docuemntation While the PostgreSQL documentation
(https://www.postgresql.org/docs/current/static/datatype.html) contains plenty (https://www.postgresql.org/docs/current/static/datatype.html) contains plenty
of information we will list the sizes of common types here so it's easier to of information we will list the sizes of common types here so it's easier to
look them up. Here "word" refers to the word size, which is 4 bytes for a 32 look them up. Here "word" refers to the word size, which is 4 bytes for a 32
......
...@@ -28,7 +28,7 @@ records should use stubs/doubles as much as possible. ...@@ -28,7 +28,7 @@ records should use stubs/doubles as much as possible.
| `app/uploaders/` | `spec/uploaders/` | RSpec | | | `app/uploaders/` | `spec/uploaders/` | RSpec | |
| `app/views/` | `spec/views/` | RSpec | | | `app/views/` | `spec/views/` | RSpec | |
| `app/workers/` | `spec/workers/` | RSpec | | | `app/workers/` | `spec/workers/` | RSpec | |
| `app/assets/javascripts/` | `spec/javascripts/` | Karma | More details in the [Frontent Testing guide](frontend_testing.md) section. | | `app/assets/javascripts/` | `spec/javascripts/` | Karma | More details in the [Frontend Testing guide](frontend_testing.md) section. |
## Integration tests ## Integration tests
......
...@@ -219,7 +219,7 @@ Blocks are a way to group related information. ...@@ -219,7 +219,7 @@ Blocks are a way to group related information.
#### Content blocks #### Content blocks
Content blocks (`.content-block`) are the basic grouping of content. They are commonly used in [lists](#lists), and are separated by a botton border. Content blocks (`.content-block`) are the basic grouping of content. They are commonly used in [lists](#lists), and are separated by a button border.
![Content block](img/components-contentblock.png) ![Content block](img/components-contentblock.png)
...@@ -281,7 +281,7 @@ Modals are only used for having a conversation and confirmation with the user. T ...@@ -281,7 +281,7 @@ Modals are only used for having a conversation and confirmation with the user. T
| Modal with 2 actions | Modal with 3 actions | Special confirmation | | Modal with 2 actions | Modal with 3 actions | Special confirmation |
| --------------------- | --------------------- | -------------------- | | --------------------- | --------------------- | -------------------- |
| ![two-actions](img/modals-general-confimation-dialog.png) | ![three-actions](img/modals-three-buttons.png) | ![spcial-confirmation](img/modals-special-confimation-dialog.png) | | ![two-actions](img/modals-general-confimation-dialog.png) | ![three-actions](img/modals-three-buttons.png) | ![special-confirmation](img/modals-special-confimation-dialog.png) |
> TODO: Special case for modal. > TODO: Special case for modal.
......
...@@ -255,7 +255,7 @@ otherwise it will raise a `TypeError`. ...@@ -255,7 +255,7 @@ otherwise it will raise a `TypeError`.
## Adding Indexes ## Adding Indexes
Adding indexes is an expensive process that blocks INSERT and UPDATE queries for Adding indexes is an expensive process that blocks INSERT and UPDATE queries for
the duration. When using PostgreSQL one can work arounds this by using the the duration. When using PostgreSQL one can work around this by using the
`CONCURRENTLY` option: `CONCURRENTLY` option:
```sql ```sql
......
...@@ -49,7 +49,7 @@ do before. ...@@ -49,7 +49,7 @@ do before.
**Use cases**: provide at least two, ideally three, use cases for every major feature. **Use cases**: provide at least two, ideally three, use cases for every major feature.
You should answer this question: what can you do with this feature/change? Use cases You should answer this question: what can you do with this feature/change? Use cases
are examples of how this feauture or change can be used in real life. are examples of how this feature or change can be used in real life.
Examples: Examples:
- CE and EE: [Issues](../user/project/issues/index.md#use-cases) - CE and EE: [Issues](../user/project/issues/index.md#use-cases)
......
...@@ -91,7 +91,7 @@ Follow the below instructions to ensure you use the most up to date requirements ...@@ -91,7 +91,7 @@ Follow the below instructions to ensure you use the most up to date requirements
#### Check for InnoDB File-Per-Table Tablespaces #### Check for InnoDB File-Per-Table Tablespaces
We need to check, enable and maybe convert your existing GitLab DB tables to the [InnoDB File-Per-Table Tablespaces](http://dev.mysql.com/doc/refman/5.7/en/innodb-multiple-tablespaces.html) as a prerequise for supporting **utfb8mb4 with long indexes** required by recent GitLab databases. We need to check, enable and maybe convert your existing GitLab DB tables to the [InnoDB File-Per-Table Tablespaces](http://dev.mysql.com/doc/refman/5.7/en/innodb-multiple-tablespaces.html) as a prerequisite for supporting **utfb8mb4 with long indexes** required by recent GitLab databases.
# Login to MySQL # Login to MySQL
mysql -u root -p mysql -u root -p
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
![GCP landing page](img/gcp_landing.png) ![GCP landing page](img/gcp_landing.png)
Gettung started with GitLab on a [Google Cloud Platform (GCP)][gcp] instance is quick and easy. Getting started with GitLab on a [Google Cloud Platform (GCP)][gcp] instance is quick and easy.
## Prerequisites ## Prerequisites
......
...@@ -50,12 +50,12 @@ Here is a snippet of the important settings: ...@@ -50,12 +50,12 @@ Here is a snippet of the important settings:
gitlabUrl: http://gitlab.your-domain.com/ gitlabUrl: http://gitlab.your-domain.com/
## The Registration Token for adding new Runners to the GitLab Server. This must ## The Registration Token for adding new Runners to the GitLab Server. This must
## be retreived from your GitLab Instance. ## be retrieved from your GitLab Instance.
## ref: https://docs.gitlab.com/ce/ci/runners/README.html#creating-and-registering-a-runner ## ref: https://docs.gitlab.com/ce/ci/runners/README.html#creating-and-registering-a-runner
## ##
runnerRegistrationToken: "" runnerRegistrationToken: ""
## Set the certsSecretName in order to pass custom certficates for GitLab Runner to use ## Set the certsSecretName in order to pass custom certificates for GitLab Runner to use
## Provide resource name for a Kubernetes Secret Object in the same namespace, ## Provide resource name for a Kubernetes Secret Object in the same namespace,
## this is used to populate the /etc/gitlab-runner/certs directory ## this is used to populate the /etc/gitlab-runner/certs directory
## ref: https://docs.gitlab.com/runner/configuration/tls-self-signed.html#supported-options-for-self-signed-certificates ## ref: https://docs.gitlab.com/runner/configuration/tls-self-signed.html#supported-options-for-self-signed-certificates
...@@ -130,7 +130,7 @@ runners: ...@@ -130,7 +130,7 @@ runners:
### Enabling RBAC support ### Enabling RBAC support
If your cluster has RBAC enabled, you can choose to either have the chart create its own sevice account or provide one. If your cluster has RBAC enabled, you can choose to either have the chart create its own service account or provide one.
To have the chart create the service account for you, set `rbac.create` to true. To have the chart create the service account for you, set `rbac.create` to true.
...@@ -208,7 +208,7 @@ You then need to provide the secret's name to the GitLab Runner chart. ...@@ -208,7 +208,7 @@ You then need to provide the secret's name to the GitLab Runner chart.
Add the following to your `values.yaml` Add the following to your `values.yaml`
```yaml ```yaml
## Set the certsSecretName in order to pass custom certficates for GitLab Runner to use ## Set the certsSecretName in order to pass custom certificates for GitLab Runner to use
## Provide resource name for a Kubernetes Secret Object in the same namespace, ## Provide resource name for a Kubernetes Secret Object in the same namespace,
## this is used to populate the /etc/gitlab-runner/certs directory ## this is used to populate the /etc/gitlab-runner/certs directory
## ref: https://docs.gitlab.com/runner/configuration/tls-self-signed.html#supported-options-for-self-signed-certificates ## ref: https://docs.gitlab.com/runner/configuration/tls-self-signed.html#supported-options-for-self-signed-certificates
......
...@@ -43,7 +43,7 @@ exclude shibboleth URLs from rewriting, add "RewriteCond %{REQUEST_URI} !/Shibbo ...@@ -43,7 +43,7 @@ exclude shibboleth URLs from rewriting, add "RewriteCond %{REQUEST_URI} !/Shibbo
RequestHeader set X_FORWARDED_PROTO 'https' RequestHeader set X_FORWARDED_PROTO 'https'
``` ```
1. Edit /etc/gitlab/gitlab.rb configuration file, your shibboleth attributes should be in form of "HTTP_ATTRIBUTE" and you should addjust them to your need and environment. Add any other configuration you need. 1. Edit /etc/gitlab/gitlab.rb configuration file, your shibboleth attributes should be in form of "HTTP_ATTRIBUTE" and you should adjust them to your need and environment. Add any other configuration you need.
File should look like this: File should look like this:
``` ```
......
...@@ -196,7 +196,7 @@ This is really useful for integrating repositories to secured, shared Continuous ...@@ -196,7 +196,7 @@ This is really useful for integrating repositories to secured, shared Continuous
Integration (CI) services or other shared services. Integration (CI) services or other shared services.
GitLab administrators can set up the Global Shared Deploy key in GitLab and GitLab administrators can set up the Global Shared Deploy key in GitLab and
add the private key to any shared systems. Individual repositories opt into add the private key to any shared systems. Individual repositories opt into
exposing their repsitory using these keys when a project masters (or higher) exposing their repository using these keys when a project masters (or higher)
authorizes a Global Shared Deploy key to be used with their project. authorizes a Global Shared Deploy key to be used with their project.
Global Shared Keys can provide greater security compared to Per-Project Deploy Global Shared Keys can provide greater security compared to Per-Project Deploy
...@@ -224,7 +224,7 @@ if there is at least one Global Deploy Key configured. ...@@ -224,7 +224,7 @@ if there is at least one Global Deploy Key configured.
CAUTION: **Warning:** CAUTION: **Warning:**
Defining Global Deploy Keys does not expose any given repository via Defining Global Deploy Keys does not expose any given repository via
the key until that respository adds the Global Deploy Key to their project. the key until that repository adds the Global Deploy Key to their project.
In this way the Global Deploy Keys enable access by other systems, but do In this way the Global Deploy Keys enable access by other systems, but do
not implicitly give any access just by setting them up. not implicitly give any access just by setting them up.
......
...@@ -89,7 +89,7 @@ A [copy](https://git-scm.com/docs/git-clone) of a repository stored on your mach ...@@ -89,7 +89,7 @@ A [copy](https://git-scm.com/docs/git-clone) of a repository stored on your mach
### Code Review ### Code Review
Examination of a progam's code. The main aim is to maintain high quality standards of code that is being shipped. Merge requests [serve as a code review tool](https://about.gitlab.com/2014/09/29/gitlab-flow/) in GitLab. Examination of a program's code. The main aim is to maintain high quality standards of code that is being shipped. Merge requests [serve as a code review tool](https://about.gitlab.com/2014/09/29/gitlab-flow/) in GitLab.
### Code Snippet ### Code Snippet
......
...@@ -354,11 +354,11 @@ add the following script to the User Data section: ...@@ -354,11 +354,11 @@ add the following script to the User Data section:
- mount -a -t nfs - mount -a -t nfs
- sudo gitlab-ctl reconfigure - sudo gitlab-ctl reconfigure
On the security group section we can chosse our existing On the security group section we can choose our existing
`gitlab-ec2-security-group` group which has already been tested. `gitlab-ec2-security-group` group which has already been tested.
After this is launched we are able to start creating our Auto Scaling After this is launched we are able to start creating our Auto Scaling
Group. Start by giving it a name and assinging it our VPC and private Group. Start by giving it a name and assigning it our VPC and private
subnets. We also want to always start with two instances and if you subnets. We also want to always start with two instances and if you
scroll down to Advanced Details we can choose to receive traffic from ELBs. scroll down to Advanced Details we can choose to receive traffic from ELBs.
Lets enable that option and select our ELB. We also want to use the ELB's Lets enable that option and select our ELB. We also want to use the ELB's
......
...@@ -163,7 +163,7 @@ Some tickets need specific knowledge or a deep understanding of a particular com ...@@ -163,7 +163,7 @@ Some tickets need specific knowledge or a deep understanding of a particular com
- Aim to have a good understanding of the problems that customers are facing - Aim to have a good understanding of the problems that customers are facing
- Aim to have gained experience in scheduling and participating in calls with customers - Aim to have gained experience in scheduling and participating in calls with customers
- Aim to have a good understanding of ticket flow through Zendesk and how to interat with our various channels - Aim to have a good understanding of ticket flow through Zendesk and how to interact with our various channels
### Stage 4 ### Stage 4
......
...@@ -27,7 +27,7 @@ project. ...@@ -27,7 +27,7 @@ project.
### Short Story of Git ### Short Story of Git
- 1991-2002: The Linux kernel was being maintaned by sharing archived files - 1991-2002: The Linux kernel was being maintained by sharing archived files
and patches. and patches.
- 2002: The Linux kernel project began using a DVCS called BitKeeper - 2002: The Linux kernel project began using a DVCS called BitKeeper
- 2005: BitKeeper revoked the free-of-charge status and Git was created - 2005: BitKeeper revoked the free-of-charge status and Git was created
......
...@@ -9,7 +9,7 @@ comments: false ...@@ -9,7 +9,7 @@ comments: false
- Useful for marking deployments and releases - Useful for marking deployments and releases
- Annotated tags are an unchangeable part of Git history - Annotated tags are an unchangeable part of Git history
- Soft/lightweight tags can be set and removed at will - Soft/lightweight tags can be set and removed at will
- Many projects combine an anotated release tag with a stable branch - Many projects combine an annotated release tag with a stable branch
- Consider setting deployment/release tags automatically - Consider setting deployment/release tags automatically
---------- ----------
......
...@@ -279,7 +279,7 @@ See GitLab merge requests for examples: ...@@ -279,7 +279,7 @@ See GitLab merge requests for examples:
- Useful for marking deployments and releases - Useful for marking deployments and releases
- Annotated tags are an unchangeable part of Git history - Annotated tags are an unchangeable part of Git history
- Soft/lightweight tags can be set and removed at will - Soft/lightweight tags can be set and removed at will
- Many projects combine an anotated release tag with a stable branch - Many projects combine an annotated release tag with a stable branch
- Consider setting deployment/release tags automatically - Consider setting deployment/release tags automatically
--- ---
......
# Sign-up restrictions # Sign-up restrictions
You can block email addresses of specific domains, or whitelist only some You can block email addresses of specific domains, or whitelist only some
specifc domains via the **Application Settings** in the Admin area. specific domains via the **Application Settings** in the Admin area.
>**Note**: These restrictions are only applied during sign-up. An admin is >**Note**: These restrictions are only applied during sign-up. An admin is
able to add add a user through the admin panel with a disallowed domain. Also able to add add a user through the admin panel with a disallowed domain. Also
......
...@@ -55,7 +55,7 @@ first group being the name of the distro and subsequent groups split like: ...@@ -55,7 +55,7 @@ first group being the name of the distro and subsequent groups split like:
Another example of GitLab as a company would be the following: Another example of GitLab as a company would be the following:
- Organization Group - GitLab - Organization Group - GitLab
- Category Subroup - Marketing - Category Subgroup - Marketing
- (project) Design - (project) Design
- (project) General - (project) General
- Category Subgroup - Software - Category Subgroup - Software
......
...@@ -56,7 +56,7 @@ With GitLab Enterprise Edition, you can also: ...@@ -56,7 +56,7 @@ With GitLab Enterprise Edition, you can also:
[Merge Request Approvals](https://docs.gitlab.com/ee/user/project/merge_requests/index.html#merge-request-approvals),