Commit b42e7740 authored by Marcia Ramos's avatar Marcia Ramos

Merge branch 'docs-fix-gitlab-capitalization-ce' into 'master'

Correcting Gitlab to GitLab in docs

See merge request gitlab-org/gitlab-ce!21827
parents 3371c946 fd7358a8
...@@ -219,7 +219,7 @@ repository from your GitLab server over HTTP. ...@@ -219,7 +219,7 @@ repository from your GitLab server over HTTP.
If you are running Gitaly [as a remote If you are running Gitaly [as a remote
service](#running-gitaly-on-its-own-server) you may want to disable service](#running-gitaly-on-its-own-server) you may want to disable
the local Gitaly service that runs on your Gitlab server by default. the local Gitaly service that runs on your GitLab server by default.
> 'Disabling Gitaly' only makes sense when you run GitLab in a custom > 'Disabling Gitaly' only makes sense when you run GitLab in a custom
cluster configuration, where different services run on different cluster configuration, where different services run on different
......
...@@ -13,7 +13,7 @@ This guide talks about how to read and use these system log files. ...@@ -13,7 +13,7 @@ This guide talks about how to read and use these system log files.
This file lives in `/var/log/gitlab/gitlab-rails/production_json.log` for This file lives in `/var/log/gitlab/gitlab-rails/production_json.log` for
Omnibus GitLab packages or in `/home/git/gitlab/log/production_json.log` for Omnibus GitLab packages or in `/home/git/gitlab/log/production_json.log` for
installations from source. (When Gitlab is running in an environment installations from source. (When GitLab is running in an environment
other than production, the corresponding logfile is shown here.) other than production, the corresponding logfile is shown here.)
It contains a structured log for Rails controller requests received from It contains a structured log for Rails controller requests received from
...@@ -42,7 +42,7 @@ In addition, the log contains the IP address from which the request originated ...@@ -42,7 +42,7 @@ In addition, the log contains the IP address from which the request originated
This file lives in `/var/log/gitlab/gitlab-rails/production.log` for This file lives in `/var/log/gitlab/gitlab-rails/production.log` for
Omnibus GitLab packages or in `/home/git/gitlab/log/production.log` for Omnibus GitLab packages or in `/home/git/gitlab/log/production.log` for
installations from source. (When Gitlab is running in an environment installations from source. (When GitLab is running in an environment
other than production, the corresponding logfile is shown here.) other than production, the corresponding logfile is shown here.)
It contains information about all performed requests. You can see the It contains information about all performed requests. You can see the
...@@ -187,7 +187,7 @@ This file lives in `/var/log/gitlab/gitlab-shell/gitlab-shell.log` for ...@@ -187,7 +187,7 @@ This file lives in `/var/log/gitlab/gitlab-shell/gitlab-shell.log` for
Omnibus GitLab packages or in `/home/git/gitlab-shell/gitlab-shell.log` for Omnibus GitLab packages or in `/home/git/gitlab-shell/gitlab-shell.log` for
installations from source. installations from source.
GitLab shell is used by Gitlab for executing Git commands and provide GitLab shell is used by GitLab for executing Git commands and provide
SSH access to Git repositories. For example: SSH access to Git repositories. For example:
``` ```
......
...@@ -58,9 +58,9 @@ Runs the following rake tasks: ...@@ -58,9 +58,9 @@ Runs the following rake tasks:
It will check that each component was set up 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 Troubleshooting Guides:
- [Trouble Shooting Guide (GitLab)](http://docs.gitlab.com/ee/README.html#troubleshooting) - [Troubleshooting Guide (GitLab)](http://docs.gitlab.com/ee/README.html#troubleshooting)
- [Trouble Shooting Guide (Omnibus Gitlab)](http://docs.gitlab.com/omnibus/README.html#troubleshooting) - [Troubleshooting Guide (Omnibus Gitlab)](http://docs.gitlab.com/omnibus/README.html#troubleshooting)
**Omnibus Installation** **Omnibus Installation**
......
# GitLab as an OAuth2 provider # GitLab as an OAuth2 provider
This document covers using the [OAuth2](https://oauth.net/2/) protocol to allow other services access Gitlab resources on user's behalf. This document covers using the [OAuth2](https://oauth.net/2/) protocol to allow other services access GitLab resources on user's behalf.
If you want GitLab to be an OAuth authentication service provider to sign into other services please see the [OAuth2 provider](../integration/oauth_provider.md) If you want GitLab to be an OAuth authentication service provider to sign into other services please see the [OAuth2 provider](../integration/oauth_provider.md)
documentation. documentation.
...@@ -9,7 +9,7 @@ This functionality is based on [doorkeeper gem](https://github.com/doorkeeper-ge ...@@ -9,7 +9,7 @@ This functionality is based on [doorkeeper gem](https://github.com/doorkeeper-ge
## Supported OAuth2 Flows ## Supported OAuth2 Flows
Gitlab currently supports following authorization flows: GitLab currently supports following authorization flows:
* *Web Application Flow* - Most secure and common type of flow, designed for the applications with secure server-side. * *Web Application Flow* - Most secure and common type of flow, designed for the applications with secure server-side.
* *Implicit Flow* - This flow is designed for user-agent only apps (e.g. single page web application running on GitLab Pages). * *Implicit Flow* - This flow is designed for user-agent only apps (e.g. single page web application running on GitLab Pages).
...@@ -76,7 +76,7 @@ Check [RFC spec](http://tools.ietf.org/html/rfc6749#section-4.2) for a detailed ...@@ -76,7 +76,7 @@ Check [RFC spec](http://tools.ietf.org/html/rfc6749#section-4.2) for a detailed
Unlike the web flow, the client receives an `access token` immediately as a result of the authorization request. The flow does not use client secret Unlike the web flow, the client receives an `access token` immediately as a result of the authorization request. The flow does not use client secret
or authorization code because all of the application code and storage is easily accessible, therefore __secrets__ can leak easily. or authorization code because all of the application code and storage is easily accessible, therefore __secrets__ can leak easily.
>**Important:** Avoid using this flow for applications that store data outside of the Gitlab instance. If you do, make sure to verify `application id` >**Important:** Avoid using this flow for applications that store data outside of the GitLab instance. If you do, make sure to verify `application id`
associated with access token before granting access to the data associated with access token before granting access to the data
(see [/oauth/token/info](https://github.com/doorkeeper-gem/doorkeeper/wiki/API-endpoint-descriptions-and-examples#get----oauthtokeninfo)). (see [/oauth/token/info](https://github.com/doorkeeper-gem/doorkeeper/wiki/API-endpoint-descriptions-and-examples#get----oauthtokeninfo)).
...@@ -146,7 +146,7 @@ access_token = client.password.get_token('user@example.com', 'secret') ...@@ -146,7 +146,7 @@ access_token = client.password.get_token('user@example.com', 'secret')
puts access_token.token puts access_token.token
``` ```
## Access Gitlab API with `access token` ## Access GitLab API with `access token`
The `access token` allows you to make requests to the API on a behalf of a user. You can pass the token either as GET parameter The `access token` allows you to make requests to the API on a behalf of a user. You can pass the token either as GET parameter
``` ```
......
# Test and deploy to Heroku a Scala application # Test and deploy to Heroku a Scala application
This example demonstrates the integration of Gitlab CI with Scala This example demonstrates the integration of GitLab CI with Scala
applications using SBT. Checkout the example applications using SBT. Checkout the example
[project](https://gitlab.com/gitlab-examples/scala-sbt) and [project](https://gitlab.com/gitlab-examples/scala-sbt) and
[build status](https://gitlab.com/gitlab-examples/scala-sbt/builds). [build status](https://gitlab.com/gitlab-examples/scala-sbt/builds).
......
...@@ -188,7 +188,7 @@ used for time of the job. The configuration of this feature is covered in ...@@ -188,7 +188,7 @@ used for time of the job. The configuration of this feature is covered in
## `before_script` and `after_script` ## `before_script` and `after_script`
> Introduced in GitLab 8.7 and requires Gitlab Runner v1.2 > Introduced in GitLab 8.7 and requires GitLab Runner v1.2
`before_script` is used to define the command that should be run before all `before_script` is used to define the command that should be run before all
jobs, including deploy jobs, but after the restoration of [artifacts](#artifacts). jobs, including deploy jobs, but after the restoration of [artifacts](#artifacts).
......
...@@ -9,7 +9,7 @@ status of the migration. ...@@ -9,7 +9,7 @@ status of the migration.
## Developing new Git features ## Developing new Git features
Starting with Gitlab 10.8, all new Git features should be developed in Starting with GitLab 10.8, all new Git features should be developed in
Gitaly. Gitaly.
> This is a new process that is not clearly defined yet. If you want > This is a new process that is not clearly defined yet. If you want
......
...@@ -242,7 +242,7 @@ Some of GitLab EE's features are too basic, in particular, issues boards which d ...@@ -242,7 +242,7 @@ Some of GitLab EE's features are too basic, in particular, issues boards which d
James and his team use CI quite heavily for several projects. Whilst they've welcomed improvements to the builds and pipelines interface, they still have some difficulty following build process on the different tabs under Pipelines. Some confusion has arisen from not knowing where to find different pieces of information or how to get to the next stages logs from the current stage's log output screen. They feel more intuitive linking and flow may alleviate the problem. Generally, they feel GitLab's navigation needs to reviewed and optimized. James and his team use CI quite heavily for several projects. Whilst they've welcomed improvements to the builds and pipelines interface, they still have some difficulty following build process on the different tabs under Pipelines. Some confusion has arisen from not knowing where to find different pieces of information or how to get to the next stages logs from the current stage's log output screen. They feel more intuitive linking and flow may alleviate the problem. Generally, they feel GitLab's navigation needs to reviewed and optimized.
#### Permissions #### Permissions
>"There is no granular control over user or group permissions. The permissions for a project are too tightly coupled to the permissions for Gitlab CI/build pipelines." >"There is no granular control over user or group permissions. The permissions for a project are too tightly coupled to the permissions for GitLab CI/build pipelines."
### Goals ### Goals
...@@ -290,7 +290,7 @@ JavaScript and SQL ...@@ -290,7 +290,7 @@ JavaScript and SQL
Web development, mobile development, UX, open source, gaming, and travel. Web development, mobile development, UX, open source, gaming, and travel.
### Motivations ### Motivations
Karolina has been using GitLab.com for around a year. She roughly spends 8 hours every week programming, of that, 2 hours is spent contributing to open source projects. Karolina contributes to open source projects to gain programming experience and to give back to the community. She likes GitLab.com for its free private repositories and range of features which provide her with everything she needs for her personal projects. Karolina is also a massive fan of GitLab's values and the fact that it isn't a "behemoth of a company". She explains that "displaying every single thing (doc, culture, assumptions, development...) in the open gives me greater confidence to choose Gitlab personally and to recommend it at work." She's also an avid reader of GitLab's blog. Karolina has been using GitLab.com for around a year. She roughly spends 8 hours every week programming, of that, 2 hours is spent contributing to open source projects. Karolina contributes to open source projects to gain programming experience and to give back to the community. She likes GitLab.com for its free private repositories and range of features which provide her with everything she needs for her personal projects. Karolina is also a massive fan of GitLab's values and the fact that it isn't a "behemoth of a company". She explains that "displaying every single thing (doc, culture, assumptions, development...) in the open gives me greater confidence to choose GitLab personally and to recommend it at work." She's also an avid reader of GitLab's blog.
Karolina works for a software development company which currently hires around 500 people. Karolina would love to use GitLab at work but the company has used GitHub Enterprise for a number of years. She describes management at her company as "old fashioned" and explains that it's "less of a technical issue and more of a cultural issue" to convince upper management to move to GitLab. Karolina is also relatively new to the company so she's apprehensive about pushing too hard to change version control platforms. Karolina works for a software development company which currently hires around 500 people. Karolina would love to use GitLab at work but the company has used GitHub Enterprise for a number of years. She describes management at her company as "old fashioned" and explains that it's "less of a technical issue and more of a cultural issue" to convince upper management to move to GitLab. Karolina is also relatively new to the company so she's apprehensive about pushing too hard to change version control platforms.
......
...@@ -5,7 +5,7 @@ in Windows, or...), put the image file into the GitLab project. You can find the ...@@ -5,7 +5,7 @@ in Windows, or...), put the image file into the GitLab project. You can find the
project as a regular folder in your files. project as a regular folder in your files.
Go to your [shell](command-line-commands.md), and move into the folder of your Go to your [shell](command-line-commands.md), and move into the folder of your
Gitlab project. This usually means running the following command until you get GitLab project. This usually means running the following command until you get
to the desired destination: to the desired destination:
``` ```
......
...@@ -93,7 +93,7 @@ You can access the GitLab instance by visiting the domain name beginning with ...@@ -93,7 +93,7 @@ You can access the GitLab instance by visiting the domain name beginning with
above, the URL would be `https://gitlab.example.com`. above, the URL would be `https://gitlab.example.com`.
If you manually created the secret for initial root password, you If you manually created the secret for initial root password, you
can use that to sign in as `root` user. If not, Gitlab automatically can use that to sign in as `root` user. If not, GitLab automatically
created a random password for `root` user. This can be extracted by the created a random password for `root` user. This can be extracted by the
following command (replace `<name>` by name of the release - which is `gitlab` following command (replace `<name>` by name of the release - which is `gitlab`
if you used the command above): if you used the command above):
......
...@@ -19,7 +19,7 @@ GitHub will generate an application ID and secret key for you to use. ...@@ -19,7 +19,7 @@ GitHub will generate an application ID and secret key for you to use.
- Application name: This can be anything. Consider something like `<Organization>'s GitLab` or `<Your Name>'s GitLab` or something else descriptive. - Application name: This can be anything. Consider something like `<Organization>'s GitLab` or `<Your Name>'s GitLab` or something else descriptive.
- Homepage URL: The URL to your GitLab installation. 'https://gitlab.company.com' - Homepage URL: The URL to your GitLab installation. 'https://gitlab.company.com'
- Application description: Fill this in if you wish. - Application description: Fill this in if you wish.
- Authorization callback URL is 'http(s)://${YOUR_DOMAIN}'. Please make sure the port is included if your Gitlab instance is not configured on default port. - Authorization callback URL is 'http(s)://${YOUR_DOMAIN}'. Please make sure the port is included if your GitLab instance is not configured on default port.
1. Select "Register application". 1. Select "Register application".
1. You should now see a Client ID and Client Secret near the top right of the page (see screenshot). 1. You should now see a Client ID and Client Secret near the top right of the page (see screenshot).
...@@ -154,7 +154,7 @@ You will also need to disable Git SSL verification on the server hosting GitLab. ...@@ -154,7 +154,7 @@ You will also need to disable Git SSL verification on the server hosting GitLab.
$ git config --global http.sslVerify false $ git config --global http.sslVerify false
``` ```
For the changes to take effect, [reconfigure Gitlab] if you installed For the changes to take effect, [reconfigure GitLab] if you installed
via Omnibus, or [restart GitLab] if you installed from source. via Omnibus, or [restart GitLab] if you installed from source.
[reconfigure GitLab]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure [reconfigure GitLab]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
......
# User email confirmation at sign-up # User email confirmation at sign-up
Gitlab admin can enable email confirmation on sign-up, if you want to confirm all GitLab admin can enable email confirmation on sign-up, if you want to confirm all
user emails before they are able to sign-in. user emails before they are able to sign-in.
In the Admin area under **Settings** (`/admin/application_settings`), go to section In the Admin area under **Settings** (`/admin/application_settings`), go to section
......
...@@ -11,7 +11,7 @@ and [Blog Articles](https://about.gitlab.com/blog/). ...@@ -11,7 +11,7 @@ and [Blog Articles](https://about.gitlab.com/blog/).
Would you like to contribute to GitLab University? Then please take a look at our contribution [process](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/PROCESS.md) for more information. Would you like to contribute to GitLab University? Then please take a look at our contribution [process](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/PROCESS.md) for more information.
## Gitlab University Curriculum ## GitLab University Curriculum
The curriculum is composed of GitLab videos, screencasts, presentations, projects and external GitLab content hosted on other services and has been organized into the following sections. The curriculum is composed of GitLab videos, screencasts, presentations, projects and external GitLab content hosted on other services and has been organized into the following sections.
......
...@@ -221,7 +221,7 @@ and the following environment variables: ...@@ -221,7 +221,7 @@ and the following environment variables:
## Cron jobs ## Cron jobs
Periodically executed jobs by Sidekiq, to self-heal Gitlab, do external Periodically executed jobs by Sidekiq, to self-heal GitLab, do external
synchronizations, run scheduled pipelines, etc.: synchronizations, run scheduled pipelines, etc.:
| Setting | GitLab.com | Default | | Setting | GitLab.com | Default |
......
...@@ -96,7 +96,7 @@ directly from GitLab. No third-party integrations needed. ...@@ -96,7 +96,7 @@ directly from GitLab. No third-party integrations needed.
- [GitLab Auto Deploy](../ci/autodeploy/index.md): Deploy your application out-of-the-box with GitLab Auto Deploy. - [GitLab Auto Deploy](../ci/autodeploy/index.md): Deploy your application out-of-the-box with GitLab Auto Deploy.
- [Review Apps](../ci/review_apps/index.md): Live-preview the changes introduced by a merge request with Review Apps. - [Review Apps](../ci/review_apps/index.md): Live-preview the changes introduced by a merge request with Review Apps.
- [GitLab Pages](project/pages/index.md): Publish your static site directly from - [GitLab Pages](project/pages/index.md): Publish your static site directly from
GitLab with Gitlab Pages. You can build, test, and deploy any Static Site Generator with Pages. GitLab with GitLab Pages. You can build, test, and deploy any Static Site Generator with Pages.
- [GitLab Container Registry](project/container_registry.md): Build and deploy Docker - [GitLab Container Registry](project/container_registry.md): Build and deploy Docker
images with Container Registry. images with Container Registry.
......
...@@ -1170,7 +1170,7 @@ You can trigger the webhook manually. Sample data from the project will be used. ...@@ -1170,7 +1170,7 @@ You can trigger the webhook manually. Sample data from the project will be used.
## Troubleshoot webhooks ## Troubleshoot webhooks
Gitlab stores each perform of the webhook. GitLab stores each perform of the webhook.
You can find records for last 2 days in "Recent Deliveries" section on the edit page of each webhook. You can find records for last 2 days in "Recent Deliveries" section on the edit page of each webhook.
![Recent deliveries](img/webhook_logs.png) ![Recent deliveries](img/webhook_logs.png)
......
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