Merge branch 'docs-fix-misspellings' into 'master'
docs: Fix misspellings in docs See merge request gitlab-org/gitlab-ce!25505
This commit is contained in:
commit
9428db8ec8
|
@ -17,7 +17,7 @@ GitLab monitors its own internal service metrics, and makes them available at th
|
||||||
`/-/metrics` endpoint. Unlike other [Prometheus] exporters, in order to access
|
`/-/metrics` endpoint. Unlike other [Prometheus] exporters, in order to access
|
||||||
it, the client IP needs to be [included in a whitelist][whitelist].
|
it, the client IP needs to be [included in a whitelist][whitelist].
|
||||||
|
|
||||||
For Omnibus and Chart installations, these metrics are automatically enabled and collected as of [GitLab 9.4](https://gitlab.com/gitlab-org/omnibus-gitlab/merge_requests/1702). For source installations or earlier verisons, these metrics will need to be enabled manually and collected by a Prometheus server.
|
For Omnibus and Chart installations, these metrics are automatically enabled and collected as of [GitLab 9.4](https://gitlab.com/gitlab-org/omnibus-gitlab/merge_requests/1702). For source installations or earlier versions, these metrics will need to be enabled manually and collected by a Prometheus server.
|
||||||
|
|
||||||
## Unicorn Metrics available
|
## Unicorn Metrics available
|
||||||
|
|
||||||
|
|
|
@ -478,7 +478,7 @@ Example response:
|
||||||
|
|
||||||
## Delete a registered Runner
|
## Delete a registered Runner
|
||||||
|
|
||||||
Deletes a registed Runner.
|
Deletes a registered Runner.
|
||||||
|
|
||||||
```
|
```
|
||||||
DELETE /runners
|
DELETE /runners
|
||||||
|
|
|
@ -89,7 +89,7 @@ page and to interact with them - for example, to click on the link back to the h
|
||||||
The simple test shown above
|
The simple test shown above
|
||||||
can already give us a lot of confidence if it passes: we know our deployment has succeeded, that the
|
can already give us a lot of confidence if it passes: we know our deployment has succeeded, that the
|
||||||
elements are visible on the page and that actual browsers can interact with it, and that routing
|
elements are visible on the page and that actual browsers can interact with it, and that routing
|
||||||
works as expected. And all that in just 10 lines with gratituous whitespace! Add to that succeeding
|
works as expected. And all that in just 10 lines with gratuitous whitespace! Add to that succeeding
|
||||||
unit tests and a successfully completed pipeline, and you can be fairly confident that the
|
unit tests and a successfully completed pipeline, and you can be fairly confident that the
|
||||||
dependency upgrade did not break anything without even having to look at your website.
|
dependency upgrade did not break anything without even having to look at your website.
|
||||||
|
|
||||||
|
|
|
@ -58,7 +58,7 @@ GitLab can be considered to have two layers from a process perspective:
|
||||||
- [Omnibus configuration options](https://gitlab.com/gitlab-org/gitaly/tree/master/doc/configuration)
|
- [Omnibus configuration options](https://gitlab.com/gitlab-org/gitaly/tree/master/doc/configuration)
|
||||||
- Layer: Core Service (Data)
|
- Layer: Core Service (Data)
|
||||||
|
|
||||||
Gitaly is a service designed by GitLab to remove our need for NFS for Git storage in distributed deployments of GitLab. (Think GitLab.com or High Availablity Deployments) As of 11.3.0, This service handles all Git level access in GitLab. You can read more about the project [in the project's readme](https://gitlab.com/gitlab-org/gitaly).
|
Gitaly is a service designed by GitLab to remove our need for NFS for Git storage in distributed deployments of GitLab (Think GitLab.com or High Availability Deployments). As of 11.3.0, this service handles all Git level access in GitLab. You can read more about the project [in the project's readme](https://gitlab.com/gitlab-org/gitaly).
|
||||||
|
|
||||||
### gitlab-monitor
|
### gitlab-monitor
|
||||||
|
|
||||||
|
@ -174,7 +174,7 @@ When making a request to an HTTP Endpoint (Think `/users/sign_in`) the request w
|
||||||
- nginx - Acts as our first line reverse proxy
|
- nginx - Acts as our first line reverse proxy
|
||||||
- gitlab-workhorse - This determines if it needs to go to the Rails application or somewhere else to reduce load on unicorn.
|
- gitlab-workhorse - This determines if it needs to go to the Rails application or somewhere else to reduce load on unicorn.
|
||||||
- unicorn - Since this is a web request, and it needs to access the application it will go to Unicorn.
|
- unicorn - Since this is a web request, and it needs to access the application it will go to Unicorn.
|
||||||
- Postgres/Gitaly/Redis - Depending on the type of request, it may hit these services to store or retreive data.
|
- Postgres/Gitaly/Redis - Depending on the type of request, it may hit these services to store or retrieve data.
|
||||||
|
|
||||||
### GitLab Git Request Cycle
|
### GitLab Git Request Cycle
|
||||||
|
|
||||||
|
|
|
@ -4,7 +4,7 @@ Thank you for your interest in contributing to GitLab. This guide details how
|
||||||
to contribute to GitLab in a way that is easy for everyone.
|
to contribute to GitLab in a way that is easy for everyone.
|
||||||
|
|
||||||
We want to create a welcoming environment for everyone who is interested in contributing.
|
We want to create a welcoming environment for everyone who is interested in contributing.
|
||||||
Please visit our [Code of Conduct page](https://about.gitlab.com/contributing/code-of-conduct) to learn more about our committment to an open and welcoming environment.
|
Please visit our [Code of Conduct page](https://about.gitlab.com/contributing/code-of-conduct) to learn more about our commitment to an open and welcoming environment.
|
||||||
|
|
||||||
For a first-time step-by-step guide to the contribution process, please see
|
For a first-time step-by-step guide to the contribution process, please see
|
||||||
["Contributing to GitLab"](https://about.gitlab.com/contributing/).
|
["Contributing to GitLab"](https://about.gitlab.com/contributing/).
|
||||||
|
|
|
@ -44,7 +44,7 @@ read through the [global navigation](global_nav.md) doc.
|
||||||
The docs site is deployed to production with GitLab Pages, and previewed in
|
The docs site is deployed to production with GitLab Pages, and previewed in
|
||||||
merge requests with Review Apps.
|
merge requests with Review Apps.
|
||||||
|
|
||||||
The deployment aspects will be soon transfered from the [original document](https://gitlab.com/gitlab-com/gitlab-docs/blob/master/README.md)
|
The deployment aspects will be soon transferred from the [original document](https://gitlab.com/gitlab-com/gitlab-docs/blob/master/README.md)
|
||||||
to this page.
|
to this page.
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
|
|
|
@ -9,7 +9,7 @@ read more about [Feature Flags][feature-flags].
|
||||||
## Apollo Client
|
## Apollo Client
|
||||||
|
|
||||||
To save duplicated clients getting created in different apps, we have a
|
To save duplicated clients getting created in different apps, we have a
|
||||||
[default client][defualt-client] that should be used. This setups the
|
[default client][default-client] that should be used. This setups the
|
||||||
Apollo client with the correct URL and also sets the CSRF headers.
|
Apollo client with the correct URL and also sets the CSRF headers.
|
||||||
|
|
||||||
## GraphQL Queries
|
## GraphQL Queries
|
||||||
|
|
|
@ -222,7 +222,7 @@ bundle exec rake gitlab:import_export:bump_version
|
||||||
|
|
||||||
### Renaming columns or models
|
### Renaming columns or models
|
||||||
|
|
||||||
This is a relatively common occurence that will require a version bump.
|
This is a relatively common occurrence that will require a version bump.
|
||||||
|
|
||||||
There is also the _RC problem_ - GitLab.com runs an RC, prior to any customers,
|
There is also the _RC problem_ - GitLab.com runs an RC, prior to any customers,
|
||||||
meaning that we want to bump the version up in the next version (or patch release).
|
meaning that we want to bump the version up in the next version (or patch release).
|
||||||
|
|
|
@ -19,7 +19,7 @@ The space between rows is also subject to alignment padding. The `user_id`
|
||||||
column takes only 4 bytes, and on 64-bit platform, 4 zeroes will be added for
|
column takes only 4 bytes, and on 64-bit platform, 4 zeroes will be added for
|
||||||
alignment padding, to allow storing the next row beginning with the "clear" word.
|
alignment padding, to allow storing the next row beginning with the "clear" word.
|
||||||
|
|
||||||
As a result, the actual size of each column would be (ommiting variable length
|
As a result, the actual size of each column would be (omitting variable length
|
||||||
data and 24-byte tuple header): 8 bytes, variable, 8 bytes. This means that
|
data and 24-byte tuple header): 8 bytes, variable, 8 bytes. This means that
|
||||||
each row will require at least 16 bytes for the two 4-byte integers. If a table
|
each row will require at least 16 bytes for the two 4-byte integers. If a table
|
||||||
has a few rows this is not an issue. However, once you start storing millions of
|
has a few rows this is not an issue. However, once you start storing millions of
|
||||||
|
|
|
@ -15,7 +15,7 @@ cannot be normally deployed.
|
||||||
|
|
||||||
Tiller is deployed into the cluster and interacts with the Kubernetes API to deploy your applications. If role based access control (RBAC) is enabled, Tiller will need to be [granted permissions](#preparing-for-helm-with-rbac) to allow it to talk to the Kubernetes API.
|
Tiller is deployed into the cluster and interacts with the Kubernetes API to deploy your applications. If role based access control (RBAC) is enabled, Tiller will need to be [granted permissions](#preparing-for-helm-with-rbac) to allow it to talk to the Kubernetes API.
|
||||||
|
|
||||||
If RBAC is not enabled, skip to [initalizing Helm](#initialize-helm).
|
If RBAC is not enabled, skip to [initializing Helm](#initialize-helm).
|
||||||
|
|
||||||
If you are not sure whether RBAC is enabled in your cluster, or to learn more, read through our [RBAC documentation](rbac.md).
|
If you are not sure whether RBAC is enabled in your cluster, or to learn more, read through our [RBAC documentation](rbac.md).
|
||||||
|
|
||||||
|
|
|
@ -92,7 +92,7 @@ To add an existing Kubernetes cluster to your project:
|
||||||
It's the URL that GitLab uses to access the Kubernetes API. Kubernetes
|
It's the URL that GitLab uses to access the Kubernetes API. Kubernetes
|
||||||
exposes several APIs, we want the "base" URL that is common to all of them,
|
exposes several APIs, we want the "base" URL that is common to all of them,
|
||||||
e.g., `https://kubernetes.example.com` rather than `https://kubernetes.example.com/api/v1`.
|
e.g., `https://kubernetes.example.com` rather than `https://kubernetes.example.com/api/v1`.
|
||||||
- **CA certificate** (requried) - A valid Kubernetes certificate is needed to authenticate to the EKS cluster. We will use the certificate created by default.
|
- **CA certificate** (required) - A valid Kubernetes certificate is needed to authenticate to the EKS cluster. We will use the certificate created by default.
|
||||||
- List the secrets with `kubectl get secrets`, and one should named similar to
|
- List the secrets with `kubectl get secrets`, and one should named similar to
|
||||||
`default-token-xxxxx`. Copy that token name for use below.
|
`default-token-xxxxx`. Copy that token name for use below.
|
||||||
- Get the certificate by running this command:
|
- Get the certificate by running this command:
|
||||||
|
|
|
@ -23,7 +23,7 @@ runbooks. A sample runbook is provided, showcasing common operations.
|
||||||
|
|
||||||
**<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
|
**<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
|
||||||
Watch this [video](https://www.youtube.com/watch?v=Q_OqHIIUPjE)
|
Watch this [video](https://www.youtube.com/watch?v=Q_OqHIIUPjE)
|
||||||
for an overview of how this is acomplished in GitLab!**
|
for an overview of how this is accomplished in GitLab!**
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
|
|
|
@ -209,7 +209,7 @@ The sample function can now be triggered from any HTTP client using a simple `PO
|
||||||
```
|
```
|
||||||
2. Using a web-based tool (ie. postman, restlet, etc)
|
2. Using a web-based tool (ie. postman, restlet, etc)
|
||||||
|
|
||||||
![function exection](img/function-execution.png)
|
![function execution](img/function-execution.png)
|
||||||
|
|
||||||
## Deploying Serverless applications
|
## Deploying Serverless applications
|
||||||
|
|
||||||
|
|
|
@ -23,7 +23,7 @@ in `.gitlab-ci.yml`.
|
||||||
## Timeout
|
## Timeout
|
||||||
|
|
||||||
Timeout defines the maximum amount of time in minutes that a job is able run.
|
Timeout defines the maximum amount of time in minutes that a job is able run.
|
||||||
This is configureable under your project's **Settings > CI/CD > General pipelines settings**.
|
This is configurable under your project's **Settings > CI/CD > General pipelines settings**.
|
||||||
The default value is 60 minutes. Decrease the time limit if you want to impose
|
The default value is 60 minutes. Decrease the time limit if you want to impose
|
||||||
a hard limit on your jobs' running time or increase it otherwise. In any case,
|
a hard limit on your jobs' running time or increase it otherwise. In any case,
|
||||||
if the job surpasses the threshold, it is marked as failed.
|
if the job surpasses the threshold, it is marked as failed.
|
||||||
|
|
Loading…
Reference in New Issue