Commit 1f2f789b authored by Craig Norris's avatar Craig Norris

Merge branch 'docs-aqualls-20200602-spelling' into 'master'

Docs: more spelling-related fixes

See merge request gitlab-org/gitlab!33637
parents 85c6168f 3bcf248a
......@@ -9,6 +9,7 @@ architected
Artifactory
Asana
Asciidoctor
Assembla
Atlassian
Auth0
Authentiq
......@@ -75,6 +76,7 @@ crosslinking
crosslinks
Crossplane
CrowdIn
datetime
Debian
deduplicate
deduplicated
......@@ -97,6 +99,7 @@ Dreamweaver
Elasticsearch
enablement
enqueued
Excon
expirable
Facebook
failover
......@@ -173,6 +176,7 @@ Laravel
LDAP
Libravatar
Lograge
Logstash
lookahead
lookaheads
lookbehind
......@@ -203,6 +207,7 @@ mitigations
mockup
mockups
ModSecurity
mutex
nameserver
nameservers
namespace
......@@ -210,6 +215,7 @@ namespaced
namespaces
Nanoc
NGINX
Nokogiri
npm
Nurtch
OAuth
......@@ -274,6 +280,7 @@ relicensing
remediations
Repmgr
Repmgrd
repurposing
requeue
requeued
requeues
......@@ -314,8 +321,11 @@ serializing
Sitespeed
Slack
Slony
smartcard
smartcards
SMTP
Sobelow
Sourcegraph
spidering
Splunk
SpotBugs
......@@ -399,6 +409,7 @@ unpublished
unpublishes
unpublishing
unreferenced
unreplicated
unresolve
unresolved
unresolving
......@@ -424,6 +435,7 @@ upvotes
validator
validators
vendored
versionless
virtualized
virtualizing
Vue
......@@ -431,6 +443,7 @@ Vuex
walkthrough
walkthroughs
WebdriverIO
Webex
webpack
webserver
whitepaper
......
......@@ -66,7 +66,7 @@ One risk of using a single bucket would be that if your organisation decided to
migrate GitLab to the Helm deployment in the future. GitLab would run, but the situation with
backups might not be realised until the organisation had a critical requirement for the backups to work.
### S3 API compatability issues
### S3 API compatibility issues
Not all S3 providers [are fully compatible](../raketasks/backup_restore.md#other-s3-providers)
with the Fog library that GitLab uses. Symptoms include:
......
......@@ -189,7 +189,7 @@ Moving past that, it is best to attempt the same search using the [Elasticsearch
If the results:
- Sync up, then there is not a technical "issue" per se. Instead, it might be a problem
- Sync up, then there is not a technical "issue." Instead, it might be a problem
with the Elasticsearch filters we are using. This can be complicated, so it is best to
escalate to GitLab support to check these and guide you on the potential on whether or
not a feature request is needed.
......
......@@ -263,7 +263,7 @@ p.import_state.mark_as_failed("Failed manually through console.")
In a specific situation, an imported repository needed to be renamed. The Support
Team was informed of a backup restore that failed on a single repository, which created
the project with an empty repository. The project was successfully restored to a dev
the project with an empty repository. The project was successfully restored to a development
instance, then exported, and imported into a new project under a different name.
The Support Team was able to transfer the incorrectly named imported project into the
......@@ -652,7 +652,7 @@ License.current.feature_available?(:jira_dev_panel_integration)
### Check if a project feature is available in a project
Features listed in <https://gitlab.com/gitlab-org/gitlab/blob/master/ee/app/models/license.rb>.
Features listed in [`license.rb`](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/app/models/license.rb).
```ruby
p = Project.find_by_full_path('<group>/<project>')
......
......@@ -55,8 +55,8 @@ This section is for links to information elsewhere in the GitLab documentation.
- [GitLab database requirements](../../install/requirements.md#database) including
- Support for MySQL was removed in GitLab 12.1; [migrate to PostgreSQL](../../update/mysql_to_postgresql.md)
- required extension pg_trgm
- required extension postgres_fdw for Geo
- required extension `pg_trgm`
- required extension `postgres_fdw` for Geo
- Errors like this in the `production/sidekiq` log; see: [Set default_transaction_isolation into read committed](https://docs.gitlab.com/omnibus/settings/database.html#set-default_transaction_isolation-into-read-committed):
......
......@@ -86,13 +86,13 @@ sudo apt-get install linux-tools-common linux-tools-generic linux-tools-`uname -
sudo yum install perf
```
Run perf against the Sidekiq PID:
Run `perf` against the Sidekiq PID:
```shell
sudo perf record -p <sidekiq_pid>
```
Let this run for 30-60 seconds and then press Ctrl-C. Then view the perf report:
Let this run for 30-60 seconds and then press Ctrl-C. Then view the `perf` report:
```shell
$ sudo perf report
......@@ -105,13 +105,13 @@ Samples: 348K of event 'cycles', Event count (approx.): 280908431073
0.10% ruby libc-2.12.so [.] _int_free
```
Above you see sample output from a perf report. It shows that 97% of the CPU is
Above you see sample output from a `perf` report. It shows that 97% of the CPU is
being spent inside Nokogiri and `xmlXPathNodeSetMergeAndClear`. For something
this obvious you should then go investigate what job in GitLab would use
Nokogiri and XPath. Combine with `TTIN` or `gdb` output to show the
corresponding Ruby code where this is happening.
## The GNU Project Debugger (gdb)
## The GNU Project Debugger (`gdb`)
`gdb` can be another effective tool for debugging Sidekiq. It gives you a little
more interactive way to look at each thread and see what's causing problems.
......
......@@ -168,8 +168,8 @@ The connection settings match those provided by [Fog](https://github.com/fog), a
| `provider` | Always `OpenStack` for compatible hosts | `OpenStack` |
| `openstack_username` | OpenStack username | |
| `openstack_api_key` | OpenStack API key | |
| `openstack_temp_url_key` | OpenStack key for generating temporary urls | |
| `openstack_auth_url` | OpenStack authentication endpont | |
| `openstack_temp_url_key` | OpenStack key for generating temporary URLs | |
| `openstack_auth_url` | OpenStack authentication endpoint | |
| `openstack_region` | OpenStack region | |
| `openstack_tenant` | OpenStack tenant ID |
......
......@@ -50,7 +50,7 @@ PUT /application/appearance
| `description` | string | no | Markdown text shown on the sign in / sign up page
| `logo` | mixed | no | Instance image used on the sign in / sign up page
| `header_logo` | mixed | no | Instance image used for the main navigation bar
| `favicon` | mixed | no | Instance favicon in .ico/.png format
| `favicon` | mixed | no | Instance favicon in `.ico` or `.png` format
| `new_project_guidelines` | string | no | Markdown text shown on the new project page
| `profile_image_guidelines` | string | no | Markdown text shown on the profile page below Public Avatar
| `header_message` | string | no | Message within the system header bar
......
......@@ -141,7 +141,7 @@ Example of response
## Create a new environment
Creates a new environment with the given name and external_url.
Creates a new environment with the given name and `external_url`.
It returns `201` if the environment was successfully created, `400` for wrong parameters.
......@@ -173,7 +173,7 @@ Example response:
## Edit an existing environment
Updates an existing environment's name and/or external_url.
Updates an existing environment's name and/or `external_url`.
It returns `200` if the environment was successfully updated. In case of an error, a status code `400` is returned.
......@@ -186,7 +186,7 @@ PUT /projects/:id/environments/:environments_id
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `environment_id` | integer | yes | The ID of the environment |
| `name` | string | no | The new name of the environment |
| `external_url` | string | no | The new external_url |
| `external_url` | string | no | The new `external_url` |
```shell
curl --request PUT --data "name=staging&external_url=https://staging.example.gitlab.com" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/1"
......
......@@ -29,11 +29,11 @@ allows clients to request exactly the data they need, making it
possible to get all required data in a limited number of requests.
The GraphQL data (fields) can be described in the form of types,
allowing clients to use [clientside GraphQL
allowing clients to use [client-side GraphQL
libraries](https://graphql.org/code/#graphql-clients) to consume the
API and avoid manual parsing.
Since there's no fixed endpoints and datamodel, new abilities can be
Since there's no fixed endpoints and data model, new abilities can be
added to the API without creating breaking changes. This allows us to
have a versionless API as described in [the GraphQL
documentation](https://graphql.org/learn/best-practices/#versioning).
......
......@@ -2,7 +2,7 @@
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/29089) in GitLab 12.10 behind a disabled feature flag.
Metrics dashboard annotations allow you to indicate events on your graphs at a single point in time or over a timespan.
Metrics dashboard annotations allow you to indicate events on your graphs at a single point in time or over a time span.
## Create a new annotation
......@@ -12,7 +12,7 @@ POST /clusters/:id/metrics_dashboard/annotations/
```
NOTE: **Note:**
The value of `dashboard_path` will be treated as a CGI-escaped path, and automatically unescaped.
The value of `dashboard_path` will be treated as a CGI-escaped path, and automatically un-escaped.
Parameters:
......
......@@ -4,7 +4,7 @@ This API is a project-specific version of these endpoints:
- [Dockerfile templates](templates/dockerfiles.md)
- [Gitignore templates](templates/gitignores.md)
- [GitLab CI/CD Config templates](templates/gitlab_ci_ymls.md)
- [GitLab CI/CD Configuration templates](templates/gitlab_ci_ymls.md)
- [Open source license templates](templates/licenses.md)
It deprecates these endpoints, which will be removed for API version 5.
......
......@@ -51,7 +51,7 @@ Parameters:
- `ref` (required) - The name of branch, tag or commit
NOTE: **Note:**
`blob_id` is the blob sha, see [repositories - Get a blob from repository](repositories.md#get-a-blob-from-repository)
`blob_id` is the blob SHA, see [repositories - Get a blob from repository](repositories.md#get-a-blob-from-repository)
In addition to the `GET` method, you can also use `HEAD` to get just file metadata.
......
......@@ -714,7 +714,7 @@ Parameters:
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `recipients` | string | true | Recipients/channels separated by whitespaces |
| `default_irc_uri` | string | false | irc://irc.network.net:6697/ |
| `default_irc_uri` | string | false | `irc://irc.network.net:6697/` |
| `server_host` | string | false | localhost |
| `server_port` | integer | false | 6659 |
| `colorize_messages` | boolean | false | Colorize messages |
......@@ -1277,7 +1277,7 @@ A continuous integration and build server
Set JetBrains TeamCity CI service for a project.
> The build configuration in Teamcity must use the build format number %build.vcs.number% you will also want to configure monitoring of all branches so merge requests build, that setting is in the vsc root advanced settings.
> The build configuration in TeamCity must use the build format number `%build.vcs.number%` you will also want to configure monitoring of all branches so merge requests build, that setting is in the VSC root advanced settings.
```plaintext
PUT /projects/:id/services/teamcity
......
......@@ -71,7 +71,7 @@ available through the UI. You can use them by creating a new file,
choosing a template that suits your application, and adjusting it
to your needs:
![Use a .gitlab-ci.yml template](img/add_file_template_11_10.png)
![Use a `.gitlab-ci.yml` template](img/add_file_template_11_10.png)
For a broader overview, see the [CI/CD getting started](quick_start/README.md) guide.
......@@ -108,7 +108,7 @@ GitLab CI/CD supports numerous configuration options:
| [Pipeline triggers](triggers/README.md) | Trigger pipelines through the API. |
| [Pipelines for Merge Requests](merge_request_pipelines/index.md) | Design a pipeline structure for running a pipeline in merge requests. |
| [Integrate with Kubernetes clusters](../user/project/clusters/index.md) | Connect your project to Google Kubernetes Engine (GKE) or an existing Kubernetes cluster. |
| [Optimize GitLab and Runner for large repositories](large_repositories/index.md) | Recommended strategies for handling large repos. |
| [Optimize GitLab and Runner for large repositories](large_repositories/index.md) | Recommended strategies for handling large repositories. |
| [`.gitlab-ci.yml` full reference](yaml/README.md) | All the attributes you can use with GitLab CI/CD. |
Note that certain operations can only be performed according to the
......
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