summaryrefslogtreecommitdiff
path: root/doc/development
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-03-26 03:07:43 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-03-26 03:07:43 +0000
commitdddde902acfa6acfb11583c61faa67cc7c8d11b6 (patch)
tree2e9fdf963c84f82995d62d0c55f91168cff3ec47 /doc/development
parent101c30f4dffc624af3cbe3f12edc2cfee570a5f3 (diff)
downloadgitlab-ce-dddde902acfa6acfb11583c61faa67cc7c8d11b6.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development')
-rw-r--r--doc/development/api_graphql_styleguide.md2
-rw-r--r--doc/development/architecture.md2
-rw-r--r--doc/development/documentation/site_architecture/index.md2
-rw-r--r--doc/development/documentation/site_architecture/release_process.md2
-rw-r--r--doc/development/fe_guide/droplab/droplab.md6
-rw-r--r--doc/development/fe_guide/style/vue.md20
-rw-r--r--doc/development/geo.md2
-rw-r--r--doc/development/go_guide/index.md2
-rw-r--r--doc/development/import_export.md2
-rw-r--r--doc/development/internal_api.md4
-rw-r--r--doc/development/merge_request_performance_guidelines.md2
-rw-r--r--doc/development/sidekiq_style_guide.md2
-rw-r--r--doc/development/testing_guide/review_apps.md2
13 files changed, 25 insertions, 25 deletions
diff --git a/doc/development/api_graphql_styleguide.md b/doc/development/api_graphql_styleguide.md
index 1c93527da0c..9844dca6bb9 100644
--- a/doc/development/api_graphql_styleguide.md
+++ b/doc/development/api_graphql_styleguide.md
@@ -537,7 +537,7 @@ Arguments can be defined within the resolver, those arguments will be
made available to the fields using the resolver. When exposing a model
that had an internal ID (`iid`), prefer using that in combination with
the namespace path as arguments in a resolver over a database
-ID. Othewise use a [globally unique ID](#exposing-global-ids).
+ID. Otherwise use a [globally unique ID](#exposing-global-ids).
We already have a `FullPathLoader` that can be included in other
resolvers to quickly find Projects and Namespaces which will have a
diff --git a/doc/development/architecture.md b/doc/development/architecture.md
index d12d4b2029c..32626c19298 100644
--- a/doc/development/architecture.md
+++ b/doc/development/architecture.md
@@ -230,7 +230,7 @@ Gitaly is a service designed by GitLab to remove our need for NFS for Git storag
- Process: `praefect`
Praefect is a transparent proxy between each Git client and the Gitaly coordinating the replication of
-repository updates to secondairy nodes.
+repository updates to secondary nodes.
#### GitLab Geo
diff --git a/doc/development/documentation/site_architecture/index.md b/doc/development/documentation/site_architecture/index.md
index c91a9882bb0..3c7f0aa91d2 100644
--- a/doc/development/documentation/site_architecture/index.md
+++ b/doc/development/documentation/site_architecture/index.md
@@ -214,7 +214,7 @@ for its search function. This is how it works:
1. GitLab is a member of the [docsearch program](https://community.algolia.com/docsearch/#join-docsearch-program),
which is the free tier of [Algolia](https://www.algolia.com/).
-1. Algolia hosts a [doscsearch config](https://github.com/algolia/docsearch-configs/blob/master/configs/gitlab.json)
+1. Algolia hosts a [DocSearch configuration](https://github.com/algolia/docsearch-configs/blob/master/configs/gitlab.json)
for the GitLab docs site, and we've worked together to refine it.
1. That [config](https://community.algolia.com/docsearch/config-file.html) is
parsed by their [crawler](https://community.algolia.com/docsearch/crawler-overview.html)
diff --git a/doc/development/documentation/site_architecture/release_process.md b/doc/development/documentation/site_architecture/release_process.md
index b81fdb66baf..45cf1a5ee76 100644
--- a/doc/development/documentation/site_architecture/release_process.md
+++ b/doc/development/documentation/site_architecture/release_process.md
@@ -11,7 +11,7 @@ The following Dockerfiles are used.
| ---------- | ------------ | ----------- |
| [`Dockerfile.bootstrap`](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/dockerfiles/Dockerfile.bootstrap) | `gitlab-docs:bootstrap` | Contains all the dependencies that are needed to build the website. If the gems are updated and `Gemfile{,.lock}` changes, the image must be rebuilt. |
| [`Dockerfile.builder.onbuild`](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/dockerfiles/Dockerfile.builder.onbuild) | `gitlab-docs:builder-onbuild` | Base image to build the docs website. It uses `ONBUILD` to perform all steps and depends on `gitlab-docs:bootstrap`. |
-| [`Dockerfile.nginx.onbuild`](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/dockerfiles/Dockerfile.nginx.onbuild) | `gitlab-docs:nginx-onbuild` | Base image to use for building documentation archives. It uses `ONBUILD` to perform all required steps to copy the archive, and relies upon its parent `Dockerfile.builder.onbuild` that is invoked when building single documentation achives (see the `Dockerfile` of each branch. |
+| [`Dockerfile.nginx.onbuild`](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/dockerfiles/Dockerfile.nginx.onbuild) | `gitlab-docs:nginx-onbuild` | Base image to use for building documentation archives. It uses `ONBUILD` to perform all required steps to copy the archive, and relies upon its parent `Dockerfile.builder.onbuild` that is invoked when building single documentation archives (see the `Dockerfile` of each branch. |
| [`Dockerfile.archives`](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/dockerfiles/Dockerfile.archives) | `gitlab-docs:archives` | Contains all the versions of the website in one archive. It copies all generated HTML files from every version in one location. |
## How to build the images
diff --git a/doc/development/fe_guide/droplab/droplab.md b/doc/development/fe_guide/droplab/droplab.md
index 1c6d895b3ab..4d7c882dc09 100644
--- a/doc/development/fe_guide/droplab/droplab.md
+++ b/doc/development/fe_guide/droplab/droplab.md
@@ -185,11 +185,11 @@ DropLab adds some CSS classes to help lower the barrier to integration.
For example:
-- The `droplab-item-selected` css class is added to items that have been selected
+- The `droplab-item-selected` CSS class is added to items that have been selected
either by a mouse click or by enter key selection.
-- The `droplab-item-active` css class is added to items that have been selected
+- The `droplab-item-active` CSS class is added to items that have been selected
using arrow key navigation.
-- You can add the `droplab-item-ignore` css class to any item that you do not want to be selectable. For example,
+- You can add the `droplab-item-ignore` CSS class to any item that you do not want to be selectable. For example,
an `<li class="divider"></li>` list divider element that should not be interactive.
## Internal events
diff --git a/doc/development/fe_guide/style/vue.md b/doc/development/fe_guide/style/vue.md
index b571707edfd..a7d8fc61752 100644
--- a/doc/development/fe_guide/style/vue.md
+++ b/doc/development/fe_guide/style/vue.md
@@ -75,7 +75,7 @@ Please check this [rules](https://github.com/vuejs/eslint-plugin-vue#bulb-rules)
1. **Props Naming:** Avoid using DOM component prop names.
1. **Props Naming:** Use kebab-case instead of camelCase to provide props in templates.
- ```javascript
+ ```html
// bad
<component class="btn">
@@ -97,7 +97,7 @@ Please check this [rules](https://github.com/vuejs/eslint-plugin-vue#bulb-rules)
1. With more than one attribute, all attributes should be on a new line:
- ```javascript
+ ```html
// bad
<component v-if="bar"
param="baz" />
@@ -117,7 +117,7 @@ Please check this [rules](https://github.com/vuejs/eslint-plugin-vue#bulb-rules)
1. The tag can be inline if there is only one attribute:
- ```javascript
+ ```html
// good
<component bar="bar" />
@@ -238,7 +238,7 @@ Please check this [rules](https://github.com/vuejs/eslint-plugin-vue#bulb-rules)
1. Shorthand `@` is preferable over `v-on`
- ```javascript
+ ```html
// bad
<component v-on:click="eventHandler"/>
@@ -248,7 +248,7 @@ Please check this [rules](https://github.com/vuejs/eslint-plugin-vue#bulb-rules)
1. Shorthand `:` is preferable over `v-bind`
- ```javascript
+ ```html
// bad
<component v-bind:class="btn"/>
@@ -258,7 +258,7 @@ Please check this [rules](https://github.com/vuejs/eslint-plugin-vue#bulb-rules)
1. Shorthand `#` is preferable over `v-slot`
- ```javascript
+ ```html
// bad
<template v-slot:header></template>
@@ -270,7 +270,7 @@ Please check this [rules](https://github.com/vuejs/eslint-plugin-vue#bulb-rules)
1. Prefer self-closing component tags
- ```javascript
+ ```html
// bad
<component></component>
@@ -282,7 +282,7 @@ Please check this [rules](https://github.com/vuejs/eslint-plugin-vue#bulb-rules)
1. Prefer a component's kebab-cased name over other styles when using it in a template
- ```javascript
+ ```html
// bad
<MyComponent />
@@ -372,7 +372,7 @@ Useful links:
1. Tooltips: Do not rely on `has-tooltip` class name for Vue components
- ```javascript
+ ```html
// bad
<span
class="has-tooltip"
@@ -392,7 +392,7 @@ Useful links:
1. Don't change `data-original-title`.
- ```javascript
+ ```html
// bad
<span data-original-title="tooltip text">Foo</span>
diff --git a/doc/development/geo.md b/doc/development/geo.md
index d3df2b421de..b922fdfa119 100644
--- a/doc/development/geo.md
+++ b/doc/development/geo.md
@@ -238,7 +238,7 @@ limited by its own restrictions. The credentials are configured as a
FDW configuration and credentials definition are managed automatically by the
Omnibus GitLab `gitlab-ctl reconfigure` command.
-#### Refeshing the Foreign Tables
+#### Refreshing the Foreign Tables
Whenever a new Geo node is configured or the database schema changes on the
**primary** node, you must refresh the foreign tables on the **secondary** node
diff --git a/doc/development/go_guide/index.md b/doc/development/go_guide/index.md
index 95167c4adf1..d23c10f19d4 100644
--- a/doc/development/go_guide/index.md
+++ b/doc/development/go_guide/index.md
@@ -242,7 +242,7 @@ to make the test output easily readable.
- Ideally, each test case should have a field with a unique identifier
to use for naming subtests. In the Go standard library, this is commonly the
`name string` field.
-- Use `want`/`expect`/`actual` when you are specifcing something in the
+- Use `want`/`expect`/`actual` when you are specifying something in the
test case that will be used for assertion.
#### Variable names
diff --git a/doc/development/import_export.md b/doc/development/import_export.md
index c969523cd40..5a7d176d1d3 100644
--- a/doc/development/import_export.md
+++ b/doc/development/import_export.md
@@ -1,6 +1,6 @@
# Import/Export development documentation
-Troubleshooing and general development guidelines and tips for the [Import/Export feature](../user/project/settings/import_export.md).
+Troubleshooting and general development guidelines and tips for the [Import/Export feature](../user/project/settings/import_export.md).
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> This document is originally based on the [Import/Export 201 presentation available on YouTube](https://www.youtube.com/watch?v=V3i1OfExotE).
diff --git a/doc/development/internal_api.md b/doc/development/internal_api.md
index b9d287d11b0..60aec3a720a 100644
--- a/doc/development/internal_api.md
+++ b/doc/development/internal_api.md
@@ -187,8 +187,8 @@ Example response:
## Instance information
-This get's some generic information about the instance. This is used
-by Geo nodes to get information about eachother
+This gets some generic information about the instance. This is used
+by Geo nodes to get information about each other
```plaintext
GET /internal/check
diff --git a/doc/development/merge_request_performance_guidelines.md b/doc/development/merge_request_performance_guidelines.md
index 7f5ffe525af..d395bf13982 100644
--- a/doc/development/merge_request_performance_guidelines.md
+++ b/doc/development/merge_request_performance_guidelines.md
@@ -435,7 +435,7 @@ We can consider the following types of storages:
### Temporary storage
The storage on production nodes is really sparse. The application should be built
-in a way that accomodates running under very limited temporary storage.
+in a way that accommodates running under very limited temporary storage.
You can expect the system on which your code runs has a total of `1G-10G`
of temporary storage. However, this storage is really shared across all
jobs being run. If your job requires to use more than `100MB` of that space
diff --git a/doc/development/sidekiq_style_guide.md b/doc/development/sidekiq_style_guide.md
index b44730b3c88..0ca25f43345 100644
--- a/doc/development/sidekiq_style_guide.md
+++ b/doc/development/sidekiq_style_guide.md
@@ -255,7 +255,7 @@ discouraged, and alternative approaches to processing the work should be
considered.
If a worker needs large amounts of both memory and CPU time, it should
-be marked as memory-bound, due to the above restrction on high urgency
+be marked as memory-bound, due to the above restriction on high urgency
memory-bound workers.
## Declaring a Job as CPU-bound
diff --git a/doc/development/testing_guide/review_apps.md b/doc/development/testing_guide/review_apps.md
index 2214d86542a..77a94de98c4 100644
--- a/doc/development/testing_guide/review_apps.md
+++ b/doc/development/testing_guide/review_apps.md
@@ -210,7 +210,7 @@ secure note named `gitlab-{ce,ee} Review App's root password`.
If [Review App Stability](https://app.periscopedata.com/app/gitlab/496118/Engineering-Productivity-Sandbox?widget=6690556&udv=785399)
dips this may be a signal that the `review-apps-ce/ee` cluster is unhealthy.
-Leading indicators may be healthcheck failures leading to restarts or majority failure for Review App deployments.
+Leading indicators may be health check failures leading to restarts or majority failure for Review App deployments.
The [Review Apps Overview dashboard](https://app.google.stackdriver.com/dashboards/6798952013815386466?project=gitlab-review-apps&timeDomain=1d)
aids in identifying load spikes on the cluster, and if nodes are problematic or the entire cluster is trending towards unhealthy.