Commit f860f06b authored by Amy Qualls's avatar Amy Qualls Committed by Craig Norris

Resolve more spelling issues in the docs

A range of fixes. Turning off spell-checking for words that are too
close to real words to be added to the dictionary, and adding
exceptions for words we are likely to use again.
parent 8066d3d2
...@@ -65,6 +65,8 @@ burnup ...@@ -65,6 +65,8 @@ burnup
cacheable cacheable
CentOS CentOS
Certbot Certbot
changeset
changesets
chai chai
chatbot chatbot
chatbots chatbots
...@@ -211,6 +213,7 @@ interdependencies ...@@ -211,6 +213,7 @@ interdependencies
interdependency interdependency
interruptible interruptible
Irker Irker
issuables
Istio Istio
Jaeger Jaeger
jasmine-jquery jasmine-jquery
...@@ -373,6 +376,10 @@ Rackspace ...@@ -373,6 +376,10 @@ Rackspace
Raspbian Raspbian
Rdoc Rdoc
reachability reachability
reauthenticate
reauthenticated
reauthenticates
reauthenticating
rebase rebase
rebased rebased
rebases rebases
......
...@@ -271,10 +271,14 @@ when rendered within GitLab, may appear different depending on the OS and browse ...@@ -271,10 +271,14 @@ when rendered within GitLab, may appear different depending on the OS and browse
Most emoji are natively supported on macOS, Windows, iOS, Android, and fall back on image-based Most emoji are natively supported on macOS, Windows, iOS, Android, and fall back on image-based
emoji where there is no support. emoji where there is no support.
<!-- vale gitlab.Spelling = NO -->
On Linux, you can download [Noto Color Emoji](https://www.google.com/get/noto/help/emoji/) On Linux, you can download [Noto Color Emoji](https://www.google.com/get/noto/help/emoji/)
to get full native emoji support. Ubuntu 18.04 (like many modern Linux distributions) has to get full native emoji support. Ubuntu 18.04 (like many modern Linux distributions) has
this font installed by default. this font installed by default.
<!-- vale gitlab.Spelling = YES -->
### Front matter ### Front matter
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/23331) in GitLab 11.6. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/23331) in GitLab 11.6.
...@@ -1268,6 +1272,8 @@ GFM auto-links almost any URL you put into your text: ...@@ -1268,6 +1272,8 @@ GFM auto-links almost any URL you put into your text:
- http://localhost:3000 - http://localhost:3000
``` ```
<!-- vale gitlab.Spelling = NO -->
- <https://www.google.com> - <https://www.google.com>
- <https://www.google.com> - <https://www.google.com>
- <ftp://ftp.us.debian.org/debian/> - <ftp://ftp.us.debian.org/debian/>
...@@ -1275,6 +1281,7 @@ GFM auto-links almost any URL you put into your text: ...@@ -1275,6 +1281,7 @@ GFM auto-links almost any URL you put into your text:
- <irc://irc.freenode.net/> - <irc://irc.freenode.net/>
- <http://localhost:3000> - <http://localhost:3000>
<!-- vale gitlab.Spelling = YES -->
### Lists ### Lists
Ordered and unordered lists can be created. Ordered and unordered lists can be created.
...@@ -1405,9 +1412,13 @@ The formula for water is H<sub>2</sub>O ...@@ -1405,9 +1412,13 @@ The formula for water is H<sub>2</sub>O
while the equation for the theory of relativity is E = mc<sup>2</sup>. while the equation for the theory of relativity is E = mc<sup>2</sup>.
``` ```
<!-- vale gitlab.Spelling = NO -->
The formula for water is H<sub>2</sub>O The formula for water is H<sub>2</sub>O
while the equation for the theory of relativity is E = mc<sup>2</sup>. while the equation for the theory of relativity is E = mc<sup>2</sup>.
<!-- vale gitlab.Spelling = YES -->
### Tables ### Tables
Tables are not part of the core Markdown spec, but they are part of GFM. Tables are not part of the core Markdown spec, but they are part of GFM.
......
...@@ -148,7 +148,7 @@ The following table depicts the various user permission levels in a project. ...@@ -148,7 +148,7 @@ The following table depicts the various user permission levels in a project.
| Add new team members | | | | ✓ | ✓ | | Add new team members | | | | ✓ | ✓ |
| Enable/disable branch protection | | | | ✓ | ✓ | | Enable/disable branch protection | | | | ✓ | ✓ |
| Push to protected branches | | | | ✓ | ✓ | | Push to protected branches | | | | ✓ | ✓ |
| Turn on/off protected branch push for devs | | | | ✓ | ✓ | | Turn on/off protected branch push for developers | | | | ✓ | ✓ |
| Enable/disable tag protections | | | | ✓ | ✓ | | Enable/disable tag protections | | | | ✓ | ✓ |
| Edit project settings | | | | ✓ | ✓ | | Edit project settings | | | | ✓ | ✓ |
| Edit project badges | | | | ✓ | ✓ | | Edit project badges | | | | ✓ | ✓ |
......
...@@ -76,12 +76,16 @@ syntax highlighted code on GitLab. ...@@ -76,12 +76,16 @@ syntax highlighted code on GitLab.
The default syntax theme is White, and you can choose among 5 different themes: The default syntax theme is White, and you can choose among 5 different themes:
<!-- vale gitlab.Spelling = NO -->
- White - White
- Dark - Dark
- Solarized light - Solarized light
- Solarized dark - Solarized dark
- Monokai - Monokai
<!-- vale gitlab.Spelling = YES -->
![Profile preferences syntax highlighting themes](img/profile-preferences-syntax-themes.png) ![Profile preferences syntax highlighting themes](img/profile-preferences-syntax-themes.png)
[Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2389) in 13.0, the theme [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2389) in 13.0, the theme
......
...@@ -57,4 +57,4 @@ If you continue to type, `@le`, the popup list changes to the following. The ...@@ -57,4 +57,4 @@ If you continue to type, `@le`, the popup list changes to the following. The
popup now only includes users where `le` appears in their username, or a word in popup now only includes users where `le` appears in their username, or a word in
their name. their name.
![Popup list which includes users whose username or name contains the string `le`](img/autocomplete_characters_example2_v12_0.png) ![Popup list which includes users whose username or name contains the string](img/autocomplete_characters_example2_v12_0.png)
...@@ -74,7 +74,7 @@ Place this code in the file `src/handler.js`. ...@@ -74,7 +74,7 @@ Place this code in the file `src/handler.js`.
In our case, `module.exports.hello` defines the `hello` handler to reference later in the `serverless.yml`. In our case, `module.exports.hello` defines the `hello` handler to reference later in the `serverless.yml`.
You can learn more about the AWS Lambda Node.js function handler and all its various options here: <https://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-handler.html> You can learn more about the [AWS Lambda Node.js function handler](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-handler.html) and all its various options in its documentation.
#### Creating a `serverless.yml` file #### Creating a `serverless.yml` file
......
...@@ -93,7 +93,7 @@ To display the Deploy Boards for a specific [environment](../../ci/environments/ ...@@ -93,7 +93,7 @@ To display the Deploy Boards for a specific [environment](../../ci/environments/
`$CI_PROJECT_PATH_SLUG` are the values of the CI variables. This is so we can `$CI_PROJECT_PATH_SLUG` are the values of the CI variables. This is so we can
lookup the proper environment in a cluster/namespace which may have more lookup the proper environment in a cluster/namespace which may have more
than one. These resources should be contained in the namespace defined in than one. These resources should be contained in the namespace defined in
the Kubernetes service setting. You can use an [Autodeploy](../../topics/autodevops/stages.md#auto-deploy) `.gitlab-ci.yml` the Kubernetes service setting. You can use an [Auto deploy](../../topics/autodevops/stages.md#auto-deploy) `.gitlab-ci.yml`
template which has predefined stages and commands to use, and automatically template which has predefined stages and commands to use, and automatically
applies the annotations. Each project must have a unique namespace in applies the annotations. Each project must have a unique namespace in
Kubernetes as well. The image below demonstrates how this is shown inside Kubernetes as well. The image below demonstrates how this is shown inside
...@@ -158,7 +158,7 @@ version of your application. ...@@ -158,7 +158,7 @@ version of your application.
## Further reading ## Further reading
- [GitLab Autodeploy](../../topics/autodevops/stages.md#auto-deploy) - [GitLab Auto deploy](../../topics/autodevops/stages.md#auto-deploy)
- [GitLab CI/CD environment variables](../../ci/variables/README.md) - [GitLab CI/CD environment variables](../../ci/variables/README.md)
- [Environments and deployments](../../ci/environments/index.md) - [Environments and deployments](../../ci/environments/index.md)
- [Kubernetes deploy example](https://gitlab.com/gitlab-examples/kubernetes-deploy) - [Kubernetes deploy example](https://gitlab.com/gitlab-examples/kubernetes-deploy)
...@@ -14,13 +14,19 @@ The [Web IDE](web_ide/index.md) and [Snippets](../snippets.md) use [Monaco Edito ...@@ -14,13 +14,19 @@ The [Web IDE](web_ide/index.md) and [Snippets](../snippets.md) use [Monaco Edito
for text editing, which internally uses the [Monarch](https://microsoft.github.io/monaco-editor/monarch.html) for text editing, which internally uses the [Monarch](https://microsoft.github.io/monaco-editor/monarch.html)
library for syntax highlighting. library for syntax highlighting.
If GitLab is guessing wrong, you can override its choice of language using the `gitlab-language` attribute in `.gitattributes`. For example, if you are working in a Prolog project and using the `.pl` file extension (which would normally be highlighted as Perl), you can add the following to your `.gitattributes` file: If GitLab is guessing wrong, you can override its choice of language using the
`gitlab-language` attribute in `.gitattributes`. For example, if you are working in a
<!-- vale gitlab.Spelling = NO --> Prolog <!-- vale gitlab.Spelling = YES -->
project and using the `.pl` file extension (which would normally be highlighted as Perl),
you can add the following to your `.gitattributes` file:
``` conf ``` conf
*.pl gitlab-language=prolog *.pl gitlab-language=prolog
``` ```
<!-- vale gitlab.Spelling = NO -->
When you check in and push that change, all `*.pl` files in your project will be highlighted as Prolog. When you check in and push that change, all `*.pl` files in your project will be highlighted as Prolog.
<!-- vale gitlab.Spelling = YES -->
The paths here are simply Git's built-in [`.gitattributes` interface](https://git-scm.com/docs/gitattributes). So, if you were to invent a file format called a `Nicefile` at the root of your project that used Ruby syntax, all you need is: The paths here are simply Git's built-in [`.gitattributes` interface](https://git-scm.com/docs/gitattributes). So, if you were to invent a file format called a `Nicefile` at the root of your project that used Ruby syntax, all you need is:
......
...@@ -62,7 +62,7 @@ Migrating to Git/GitLab will benefit you: ...@@ -62,7 +62,7 @@ Migrating to Git/GitLab will benefit you:
an open source end-to-end software development platform with built-in version an open source end-to-end software development platform with built-in version
control, issue tracking, code review, CI/CD, and more. control, issue tracking, code review, CI/CD, and more.
- **Support for many network protocols**. Git supports SSH, HTTP/HTTPS and rsync - **Support for many network protocols**. Git supports SSH, HTTP/HTTPS and rsync
among others, whereas CVS supports only SSH and its own insecure pserver among others, whereas CVS supports only SSH and its own insecure `pserver`
protocol with no user authentication. protocol with no user authentication.
## How to migrate ## How to migrate
...@@ -70,7 +70,7 @@ Migrating to Git/GitLab will benefit you: ...@@ -70,7 +70,7 @@ Migrating to Git/GitLab will benefit you:
Here's a few links to get you started with the migration: Here's a few links to get you started with the migration:
- [Migrate using the `cvs-fast-export` tool](https://gitlab.com/esr/cvs-fast-export) - [Migrate using the `cvs-fast-export` tool](https://gitlab.com/esr/cvs-fast-export)
- [Stack Overflow post on importing the CVS repo](https://stackoverflow.com/a/11490134/974710) - [Stack Overflow post on importing the CVS repository](https://stackoverflow.com/a/11490134/974710)
- [Convert a CVS repository to Git](https://www.techrepublic.com/blog/linux-and-open-source/convert-cvs-repositories-to-git/) - [Convert a CVS repository to Git](https://www.techrepublic.com/blog/linux-and-open-source/convert-cvs-repositories-to-git/)
- [Man page of the `git-cvsimport` tool](https://mirrors.edge.kernel.org/pub/software/scm/git/docs/git-cvsimport.html) - [Man page of the `git-cvsimport` tool](https://mirrors.edge.kernel.org/pub/software/scm/git/docs/git-cvsimport.html)
- [Migrate using `reposurgeon`](http://www.catb.org/~esr/reposurgeon/repository-editing.html#conversion) - [Migrate using `reposurgeon`](http://www.catb.org/~esr/reposurgeon/repository-editing.html#conversion)
...@@ -29,7 +29,8 @@ If you want to continue monitoring your dependencies, see the ...@@ -29,7 +29,8 @@ If you want to continue monitoring your dependencies, see the
## What happened to my account? ## What happened to my account?
Your account has been automatically closed on May 15th, 2018. If you had a paid Your account has been automatically closed on May 15th, 2018. If you had a paid
subscription at that time, your card will be refunded on a pro rata temporis basis. subscription at that time, your card will be refunded on a
<!-- vale gitlab.Spelling = NO --> pro rata temporis <!-- vale gitlab.Spelling = YES --> basis.
You may contact `gemnasium@gitlab.com` regarding your closed account. You may contact `gemnasium@gitlab.com` regarding your closed account.
## Will my account/data be transferred to GitLab Inc.? ## Will my account/data be transferred to GitLab Inc.?
...@@ -66,15 +67,18 @@ GitHub.com or GitHub Enterprise repository. This will automatically prompt ...@@ -66,15 +67,18 @@ GitHub.com or GitHub Enterprise repository. This will automatically prompt
GitLab CI/CD to run whenever code is pushed to GitHub and post CI/CD results GitLab CI/CD to run whenever code is pushed to GitHub and post CI/CD results
back to both GitLab and GitHub when completed. back to both GitLab and GitHub when completed.
1. Create a new project, and select "CI/CD for external repo": <!-- vale gitlab.Spelling = NO -->
1. Create a new project, and select **CI/CD for external repo**:
![Create new Project](img/gemnasium/create_project_v13_5.png) ![Create new Project](img/gemnasium/create_project_v13_5.png)
<!-- vale gitlab.Spelling = YES -->
1. Use the "GitHub" button to connect your repositories. 1. Use the **GitHub** button to connect your repositories.
![Connect from GitHub](img/gemnasium/connect_github_v13_5.png) ![Connect from GitHub](img/gemnasium/connect_github_v13_5.png)
1. Select the project(s) to be set up with GitLab CI/CD and chose "Connect". 1. Select the project(s) to be set up with GitLab CI/CD and choose **Connect**.
![Select projects](img/gemnasium/select_project_v13_5.png) ![Select projects](img/gemnasium/select_project_v13_5.png)
......
...@@ -9,11 +9,17 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -9,11 +9,17 @@ info: To determine the technical writer assigned to the Stage/Group associated w
You can import your existing repositories by providing the Git URL: You can import your existing repositories by providing the Git URL:
1. From your GitLab dashboard click **New project** <!-- vale gitlab.Spelling = NO -->
1. Switch to the **Import project** tab <!-- vale gitlab.SubstitutionWarning = NO -->
1. Click on the **Repo by URL** button
1. Fill in the "Git repository URL" and the remaining project fields 1. From your GitLab dashboard click **New project**.
1. Click **Create project** to begin the import process 1. Switch to the **Import project** tab.
1. Once complete, you will be redirected to your newly created project 1. Click on the **Repo by URL** button.
1. Fill in the "Git repository URL" and the remaining project fields.
1. Click **Create project** to begin the import process.
1. Once complete, you will be redirected to your newly created project.
<!-- vale gitlab.Spelling = YES -->
<!-- vale gitlab.SubstitutionWarning = YES -->
![Import project by repository URL](img/import_projects_from_repo_url.png) ![Import project by repository URL](img/import_projects_from_repo_url.png)
...@@ -10,7 +10,7 @@ GitLab provides a way to push update messages to an Irker server. When ...@@ -10,7 +10,7 @@ GitLab provides a way to push update messages to an Irker server. When
configured, pushes to a project trigger the service to send data directly configured, pushes to a project trigger the service to send data directly
to the Irker server. to the Irker server.
See the project homepage for further information: <https://gitlab.com/esr/irker> See the [project homepage](https://gitlab.com/esr/irker) for further information.
## Needed setup ## Needed setup
......
...@@ -20,7 +20,7 @@ which stores tabular data in plain text. ...@@ -20,7 +20,7 @@ which stores tabular data in plain text.
> _CSVs are a handy way of getting data from one program to another where one program cannot read the other ones normal output._ [Ref](https://www.quora.com/What-is-a-CSV-file-and-its-uses) > _CSVs are a handy way of getting data from one program to another where one program cannot read the other ones normal output._ [Ref](https://www.quora.com/What-is-a-CSV-file-and-its-uses)
CSV files can be used with any plotter or spreadsheet-based program, such as Microsoft Excel, CSV files can be used with any plotter or spreadsheet-based program, such as Microsoft Excel,
Open Office Calc, or Google Spreadsheets. Open Office <!-- vale gitlab.Spelling = NO --> Calc, <!-- vale gitlab.Spelling = NO --> or Google Spreadsheets.
## Use cases ## Use cases
......
...@@ -32,7 +32,9 @@ nor credit card transactions, then why do we need secure connections? ...@@ -32,7 +32,9 @@ nor credit card transactions, then why do we need secure connections?
Back in the 1990s, where HTTPS came out, [SSL](https://en.wikipedia.org/wiki/Transport_Layer_Security#SSL_1.0.2C_2.0_and_3.0) was considered a "special" Back in the 1990s, where HTTPS came out, [SSL](https://en.wikipedia.org/wiki/Transport_Layer_Security#SSL_1.0.2C_2.0_and_3.0) was considered a "special"
security measure, necessary just for big companies like banks and shopping sites security measure, necessary just for big companies like banks and shopping sites
with financial transactions. with financial transactions.
<!-- vale gitlab.Spelling = NO -->
Now we have a different picture. [According to Josh Aas](https://letsencrypt.org/2015/10/29/phishing-and-malware.html), Executive Director at [ISRG](https://en.wikipedia.org/wiki/Internet_Security_Research_Group): Now we have a different picture. [According to Josh Aas](https://letsencrypt.org/2015/10/29/phishing-and-malware.html), Executive Director at [ISRG](https://en.wikipedia.org/wiki/Internet_Security_Research_Group):
<!-- vale gitlab.rulename = YES -->
> _We’ve since come to realize that HTTPS is important for almost all websites. It’s important for any website that allows people to log in with a password, any website that [tracks its users](https://www.washingtonpost.com/news/the-switch/wp/2013/12/10/nsa-uses-google-cookies-to-pinpoint-targets-for-hacking/) in any way, any website that [doesn’t want its content altered](https://arstechnica.com/tech-policy/2014/09/why-comcasts-javascript-ad-injections-threaten-security-net-neutrality/), and for any site that offers content people might not want others to know they are consuming. We’ve also learned that any site not secured by HTTPS [can be used to attack other sites](https://krebsonsecurity.com/2015/04/dont-be-fodder-for-chinas-great-cannon/)._ > _We’ve since come to realize that HTTPS is important for almost all websites. It’s important for any website that allows people to log in with a password, any website that [tracks its users](https://www.washingtonpost.com/news/the-switch/wp/2013/12/10/nsa-uses-google-cookies-to-pinpoint-targets-for-hacking/) in any way, any website that [doesn’t want its content altered](https://arstechnica.com/tech-policy/2014/09/why-comcasts-javascript-ad-injections-threaten-security-net-neutrality/), and for any site that offers content people might not want others to know they are consuming. We’ve also learned that any site not secured by HTTPS [can be used to attack other sites](https://krebsonsecurity.com/2015/04/dont-be-fodder-for-chinas-great-cannon/)._
......
...@@ -280,8 +280,10 @@ To export requirements: ...@@ -280,8 +280,10 @@ To export requirements:
### Exported CSV file format ### Exported CSV file format
<!-- vale gitlab.Spelling = NO -->
You can preview the exported CSV file in a spreadsheet editor, such as Microsoft Excel, You can preview the exported CSV file in a spreadsheet editor, such as Microsoft Excel,
OpenOffice Calc, or Google Sheets. OpenOffice Calc, or Google Sheets.
<!-- vale gitlab.Spelling = YES -->
The exported CSV file contains the following columns: The exported CSV file contains the following columns:
......
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