diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/merge_requests.md | 2 | ||||
-rw-r--r-- | doc/api/notes.md | 2 | ||||
-rw-r--r-- | doc/development/architecture.md | 2 | ||||
-rw-r--r-- | doc/install/requirements.md | 4 | ||||
-rw-r--r-- | doc/integration/bitbucket.md | 17 | ||||
-rw-r--r-- | doc/markdown/markdown.md | 2 | ||||
-rw-r--r-- | doc/ssh/README.md | 2 |
7 files changed, 16 insertions, 15 deletions
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index 1f3fd26a241..6a272539e45 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -375,7 +375,7 @@ Parameters: } }, { - "note": "_Status changed to closed_", + "note": "Status changed to closed", "author": { "id": 11, "username": "admin", diff --git a/doc/api/notes.md b/doc/api/notes.md index c22e493562a..ee2f9fa0eac 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -21,7 +21,7 @@ Parameters: [ { "id": 302, - "body": "_Status changed to closed_", + "body": "Status changed to closed", "attachment": null, "author": { "id": 1, diff --git a/doc/development/architecture.md b/doc/development/architecture.md index 714cc016004..541af487bb1 100644 --- a/doc/development/architecture.md +++ b/doc/development/architecture.md @@ -54,7 +54,7 @@ To serve repositories over SSH there's an add-on application called gitlab-shell ![GitLab Diagram Overview](gitlab_diagram_overview.png) -A typical install of GitLab will be on Ubuntu Linux or RHEL/CentOS. It uses Nginx or Apache as a web front end to proxypass the Unicorn web server. By default, communication between Unicorn and the front end is via a Unix domain socket but forwarding requests via TCP is also supported. The web front end accesses `/home/git/gitlab/public` bypassing the Unicorn server to serve static pages, uploads (e.g. avatar images or attachments), and precompiled assets. GitLab serves web pages and a [GitLab API](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/doc/api) using the Unicorn web server. It uses Sidekiq as a job queue which, in turn, uses redis as a non-persistent database backend for job information, meta data, and incoming jobs. +A typical install of GitLab will be on GNU/Linux. It uses Nginx or Apache as a web front end to proxypass the Unicorn web server. By default, communication between Unicorn and the front end is via a Unix domain socket but forwarding requests via TCP is also supported. The web front end accesses `/home/git/gitlab/public` bypassing the Unicorn server to serve static pages, uploads (e.g. avatar images or attachments), and precompiled assets. GitLab serves web pages and a [GitLab API](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/doc/api) using the Unicorn web server. It uses Sidekiq as a job queue which, in turn, uses redis as a non-persistent database backend for job information, meta data, and incoming jobs. The GitLab web app uses MySQL or PostgreSQL for persistent database information (e.g. users, permissions, issues, other meta data). GitLab stores the bare git repositories it serves in `/home/git/repositories` by default. It also keeps default branch and hook information with the bare repository. `/home/git/gitlab-satellites` keeps checked out repositories when performing actions such as a merge request, editing files in the web interface, etc. diff --git a/doc/install/requirements.md b/doc/install/requirements.md index f42af65796f..7a3216dd2d2 100644 --- a/doc/install/requirements.md +++ b/doc/install/requirements.md @@ -76,7 +76,7 @@ Notice: The 25 workers of Sidekiq will show up as separate processes in your pro ## Unicorn Workers -It's possible to increase the amount of unicorn workers and tis will usually help for to reduce the response time of the applications and increase the ability to handle parallel requests. +It's possible to increase the amount of unicorn workers and this will usually help for to reduce the response time of the applications and increase the ability to handle parallel requests. For most instances we recommend using: CPU cores + 1 = unicorn workers. So for a machine with 2 cores, 3 unicorn workers is ideal. @@ -106,4 +106,4 @@ On a very active server (10,000 active users) the Sidekiq process can use 1GB+ o - Firefox (Latest released version and [latest ESR version](https://www.mozilla.org/en-US/firefox/organizations/)) - Safari 7+ (known problem: required fields in html5 do not work) - Opera (Latest released version) -- IE 10+ +- IE 10+
\ No newline at end of file diff --git a/doc/integration/bitbucket.md b/doc/integration/bitbucket.md index cc6389f5aaf..d82e1f8b41b 100644 --- a/doc/integration/bitbucket.md +++ b/doc/integration/bitbucket.md @@ -2,7 +2,7 @@ Import projects from Bitbucket and login to your GitLab instance with your Bitbucket account. -To enable the Bitbucket OmniAuth provider you must register your application with Bitbucket. +To enable the Bitbucket OmniAuth provider you must register your application with Bitbucket. Bitbucket will generate an application ID and secret key for you to use. 1. Sign in to Bitbucket. @@ -19,8 +19,8 @@ Bitbucket will generate an application ID and secret key for you to use. - URL: The URL to your GitLab installation. 'https://gitlab.company.com' 1. Select "Save". -1. You should now see a Key and Secret in the list of OAuth customers. - Keep this page open as you continue configuration. +1. You should now see a Key and Secret in the list of OAuth customers. + Keep this page open as you continue configuration. 1. On your GitLab server, open the configuration file. @@ -70,13 +70,13 @@ Bitbucket will generate an application ID and secret key for you to use. 1. Restart GitLab for the changes to take effect. -On the sign in page there should now be a Bitbucket icon below the regular sign in form. -Click the icon to begin the authentication process. Bitbucket will ask the user to sign in and authorize the GitLab application. +On the sign in page there should now be a Bitbucket icon below the regular sign in form. +Click the icon to begin the authentication process. Bitbucket will ask the user to sign in and authorize the GitLab application. If everything goes well the user will be returned to GitLab and will be signed in. ## Bitbucket project import -To allow projects to be imported directly into GitLab, Bitbucket requires two extra setup steps compared to GitHub and GitLab.com. +To allow projects to be imported directly into GitLab, Bitbucket requires two extra setup steps compared to GitHub and GitLab.com. Bitbucket doesn't allow OAuth applications to clone repositories over HTTPS, and instead requires GitLab to use SSH and identify itself using your GitLab server's SSH key. @@ -95,7 +95,7 @@ To allow GitLab to connect to Bitbucket over SSH, you need to add 'bitbucket.org ```sh The authenticity of host 'bitbucket.org (207.223.240.182)' can't be established. RSA key fingerprint is 97:8c:1b:f2:6f:14:6b:5c:3b:ec:aa:46:46:74:7c:40. - Are you sure you want to continue connecting (yes/no)? + Are you sure you want to continue connecting (yes/no)? ``` 1. If the fingerprint matches, type `yes` to continue connecting and have 'bitbucket.org' be added to your known hosts. @@ -104,7 +104,7 @@ To allow GitLab to connect to Bitbucket over SSH, you need to add 'bitbucket.org ### Step 2: Public key -To be able to access repositories on Bitbucket, GitLab will automatically register your public key with Bitbucket as a deploy key for the repositories to be imported. Your public key needs to be at `~/.ssh/id_rsa.pub`, which will expand to `/home/git/.ssh/id_rsa.pub` in most configurations. +To be able to access repositories on Bitbucket, GitLab will automatically register your public key with Bitbucket as a deploy key for the repositories to be imported. Your public key needs to be at `~/.ssh/bitbucket_rsa.pub`, which will expand to `/home/git/.ssh/bitbucket_rsa.pub` in most configurations. If you have that file in place, you're all set and should see the "Import projects from Bitbucket" option enabled. If you don't, do the following: @@ -114,6 +114,7 @@ If you have that file in place, you're all set and should see the "Import projec sudo -u git -H ssh-keygen ``` + When asked `Enter file in which to save the key` specify the correct path, eg. `/home/git/.ssh/bitbucket_rsa`. Make sure to use an **empty passphrase**. 2. Restart GitLab to allow it to find the new public key. diff --git a/doc/markdown/markdown.md b/doc/markdown/markdown.md index 4ab73df8af9..d1f21dd7dc3 100644 --- a/doc/markdown/markdown.md +++ b/doc/markdown/markdown.md @@ -6,7 +6,7 @@ * [Newlines](#newlines) * [Multiple underscores in words](#multiple-underscores-in-words) -* [URL auto-linking](#url-autolinking) +* [URL auto-linking](#url-auto-linking) * [Code and Syntax Highlighting](#code-and-syntax-highlighting) * [Emoji](#emoji) * [Special GitLab references](#special-gitlab-references) diff --git a/doc/ssh/README.md b/doc/ssh/README.md index 6fe23dfa2a6..66941521c2e 100644 --- a/doc/ssh/README.md +++ b/doc/ssh/README.md @@ -45,7 +45,7 @@ clip < ~/.ssh/id_rsa.pub pbcopy < ~/.ssh/id_rsa.pub ``` -**Linux (requires xclip):** +**GNU/Linux (requires xclip):** ```bash xclip -sel clip < ~/.ssh/id_rsa.pub ``` |