Skip to content

Commit 2e7cdf4

Browse files
authored
Big spell check (#57)
1 parent 369f9ca commit 2e7cdf4

File tree

24 files changed

+52
-52
lines changed

24 files changed

+52
-52
lines changed

docs/access/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ This documentation guides users through the process of accessing CSCS systems an
88

99
<div class="grid cards" markdown>
1010

11-
- :fontawesome-solid-layer-group: __Multi Factor Authentification__
11+
- :fontawesome-solid-layer-group: __Multi Factor Authentication__
1212

13-
Before signing in to CSCS' web portals or using SSH, all users have to set up multi factor authentification (MFA)
13+
Before signing in to CSCS' web portals or using SSH, all users have to set up multi factor authentication (MFA)
1414

1515
[:octicons-arrow-right-24: MFA][ref-mfa]
1616

1717
- :fontawesome-solid-layer-group: __Web Services__
1818

19-
Before signing in to CSCS' web portals or using SSH, all users have to set up multi factor authentification (MFA)
19+
Before signing in to CSCS' web portals or using SSH, all users have to set up multi factor authentication (MFA)
2020

2121
[:octicons-arrow-right-24: Accessing CSCS web services][ref-access-web]
2222

docs/access/mfa.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[](){#ref-mfa}
2-
# Multi Factor Authentification
2+
# Multi Factor Authentication
33

44
To access CSCS services and systems users are required to authenticate using multi-factor authentication (MFA).
55
MFA is implemented as a two-factor authentication, where one factor is the login and password pair ("the thing you know") and the other factor is the device which generates one-time passwords (OTPs, "the thing you have").
@@ -18,7 +18,7 @@ When you first log in to any of the CSCS web applications such as UMP, Jupyter,
1818
Firstly, you will be asked to provide a code that you received by email.
1919
After this validation step, you will need to scan a QR code with your mobile phone using an application such as Google Authenticator.
2020
Lastly, you will need to enter the OTP from the authenticator application to complete the registration of your device.
21-
From then on, two-factor authrentication will be required to access CSCS services and systems.
21+
From then on, two-factor authentication will be required to access CSCS services and systems.
2222
A more detailed explanation of the registration process is provided in the next section.
2323

2424
!!! warning
@@ -42,7 +42,7 @@ You can download Google Authenticator for your phone:
4242
Before starting, ensure that the following pre-requisites are satisfied
4343

4444
1. You have an invitation email from CSCS for MFA enrollment
45-
* a notification email will be sent atleast one week before we sent the invitation email.
45+
* a notification email will be sent at least one week before we sent the invitation email.
4646
2. You have installed an OTP Authenticator app on your mobile device (see above).
4747

4848
!!! note
@@ -61,7 +61,7 @@ Steps:
6161
1. Access any of the CSCS Web applications such as [`account.cscs.ch`](https://account.cscs.ch), Jupyter, etc., on a new browser session which will redirects you to the CSCS login page.
6262
2. Log in with your username and password.
6363
3. You will be asked to key in a code which CSCS Authentication system sent to you by email.
64-
After successfaul validation of the code you will be redirected to the next page which present a QR code.
64+
After successful validation of the code you will be redirected to the next page which present a QR code.
6565
4. Scan the QR code with the authenticator app that was installed on your mobile device.
6666
After scanning the QR code the authenticator app will start generating a new 6 digit OTP every 60 seconds.
6767
5. To complete the OTP registration process, please enter the 6 digit OTP from the authenticator app at the bottom of the the same QR code page. Optionally, you can input your device name where you imported the OTP seed by scanning the QR code

docs/access/ssh.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[](){#ref-ssh}
22
# Using SSH
33

4-
Before accessing CSCS clusters using SSH, first ensure that you have [created a user account][ref-account-management] that is part of a project that has access to the cluster, and have [multi factor authentification][ref-mfa] configured.
4+
Before accessing CSCS clusters using SSH, first ensure that you have [created a user account][ref-account-management] that is part of a project that has access to the cluster, and have [multi factor authentication][ref-mfa] configured.
55

66
[](){#ref-ssh-service}
77
## Generating Keys with SSHService
@@ -53,14 +53,14 @@ The next step is to use either the bash or python scripts:
5353
pip install -r requirements.txt
5454
```
5555

56-
Therafter, activate the venv before using the script:
56+
Thereafter, activate the venv before using the script:
5757

5858
```bash
5959
source mfa/bin/activate
6060
python cscs-keygen.py
6161
```
6262

63-
For both approaches, follow the on screen instructions that require you to enter your username, password and the six-digit OTP from the authentifactor app on your phone.
63+
For both approaches, follow the on screen instructions that require you to enter your username, password and the six-digit OTP from the authenticator app on your phone.
6464
The script generates the key pair (`cscs-key` and `cscs-key-cert.pub`) in your `~/.ssh` path:
6565

6666
```bash
@@ -85,7 +85,7 @@ chmod 0600 ~/.ssh/cscs-key
8585

8686
### Adding a password to the key
8787

88-
Once the key has been generated using either the CLI or web interface above, it is strongly reccomended that you add a password to the generated key using the [ssh-keygen](https://www.ssh.com/academy/ssh/keygen) tool.
88+
Once the key has been generated using either the CLI or web interface above, it is strongly recommended that you add a password to the generated key using the [ssh-keygen](https://www.ssh.com/academy/ssh/keygen) tool.
8989

9090
```
9191
ssh-keygen -f ~/.ssh/cscs-key -p
@@ -151,14 +151,14 @@ ssh daint
151151
[](){#ref-ssh-agent}
152152
### Using SSH Agent
153153

154-
Alternatively, the [SSH authentification agent](https://www.ssh.com/academy/ssh/add-command) can be configured to manage the keys.
154+
Alternatively, the [SSH authentication agent](https://www.ssh.com/academy/ssh/add-command) can be configured to manage the keys.
155155

156156
Each time a new key is generated using the [SSHService][ref-ssh-service], add the key to the SSH agent:
157157
```
158158
ssh-add -t 1d ~/.ssh/cscs-key
159159
```
160160

161-
??? warning "Could not open a connection to your authentification agent"
161+
??? warning "Could not open a connection to your authentication agent"
162162
If you see this error message, the ssh agent is not running.
163163
You can start it with the following command:
164164
```
@@ -177,7 +177,7 @@ ssh daint.cscs.ch
177177
[](){#ref-ssh-faq}
178178
## Frequently encountered issues
179179

180-
??? warning "too many authentification failures"
180+
??? warning "too many authentication failures"
181181
You may have too many keys in your ssh agent.
182182
Remove the unused keys from the agent or flush them all with the following command:
183183
```bash

docs/access/web.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This gives users the comfort of not having to sign in multiple times in each ind
66
Furthermore, the Single Sign-On gate allow users to recover their forgotten passwords and authenticate using a third-party account. The login page looks like
77

88
[](){#ref-web-mfa}
9-
## Using MFA to acccess web-based services
9+
## Using MFA to access web-based services
1010

1111
After having completed the setup of [MFA][ref-mfa], you will be asked to enter your login/password and the OTP to access all web-based services.
1212

docs/build-install/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
CSCS provides commonly used software and tools on Alps, however many use cases will require first installing software on a system before you can start working.
44

5-
Modern HPC applications and software stacks are often very complicated, and there is no one-size-fits-all method for building and installning them.
5+
Modern HPC applications and software stacks are often very complicated, and there is no one-size-fits-all method for building and installing them.
66

77
## Programming environments
88

docs/build-install/uenv.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ For more documentation on how to find, download and use uenv in your workflow, s
66
## Building software using Spack
77

88
Each uenv is tightly coupled with [Spack] and can be used as an upstream [Spack] instance, because
9-
the sofware in uenv is built with [Spack] using the [Stackinator] tool.
9+
the software in uenv is built with [Spack] using the [Stackinator] tool.
1010

1111
CSCS provides `uenv-spack` - a tool that can be used to quickly install software using the software and configuration provided inside a uenv, similarly to how `module load` loads software packages.
1212

docs/clusters/clariden.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ Scratch is per user - each user gets separate scratch path and quota.
4242
!!! warning "scratch cleanup policy"
4343
Files that have not been accessed in 30 days are automatically deleted.
4444

45-
**Scratch is not intended for permanant storage**: transfer files back to the capstor project storage after job runs.
45+
**Scratch is not intended for permanent storage**: transfer files back to the capstor project storage after job runs.
4646

4747
!!! note
48-
There is an additional scratch path mounted on [Capstor][ref-alps-capstor] at `/capstor/scratch/cscs/$USER`, however this is not reccomended for ML workloads for performance reasons.
48+
There is an additional scratch path mounted on [Capstor][ref-alps-capstor] at `/capstor/scratch/cscs/$USER`, however this is not recommended for ML workloads for performance reasons.
4949

5050
### Project
5151

@@ -127,7 +127,7 @@ See the SLURM documentation for instructions on how to run jobs on the [Grace-Ho
127127
| normal | 1266 | 1-infinite | 1-00:00:00 | 812/371 |
128128
| xfer | 2 | 1 | 1-00:00:00 | 1/1 |
129129
```
130-
The last column shows the number of nodes that have been allocted in currently running jobs (`A`) and the number of jobs that are idle (`I`).
130+
The last column shows the number of nodes that have been allocated in currently running jobs (`A`) and the number of jobs that are idle (`I`).
131131

132132
### FirecREST
133133

docs/contributing/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Clone your fork repository on your PC/laptop:
1919
# ... make your edits ...
2020
# add and commit your changes
2121
> git add <files>
22-
> git commit -m 'update the ssh docs with alisases for all user lab vclusters'
22+
> git commit -m 'update the ssh docs with aliases for all user lab vclusters'
2323
> git push origin 'fix/ssh-alias'
2424
```
2525
Then navigate to GitHub, and create a pull request.
@@ -163,7 +163,7 @@ See the good and bad examples below for an example of of what happens when a cha
163163

164164
The diff in this case affects the original 3 lines, and creates a new one.
165165

166-
This method defines a canonical represention of text, i.e. there is one and only one way to write a paragraph of text, which plays much better with git.
166+
This method defines a canonical representation of text, i.e. there is one and only one way to write a paragraph of text, which plays much better with git.
167167

168168
* changes to the text are less likely to create merge conflicts
169169
* changing one line of text will not modify the surrounding lines (see example above)
@@ -173,7 +173,7 @@ This method defines a canonical represention of text, i.e. there is one and only
173173

174174
The documentation does not have a FAQ section, because questions are best answered by the documentation, not in a separate section.
175175
Integrating information into the main documentation requires some care to identify where the information needs to go, and edit the documentation around it.
176-
Adding the information to a FAQ is easier, but the result is information about a topic distributed betwen the docs and FAQ questions, which ultimately makes the documentation harder to search.
176+
Adding the information to a FAQ is easier, but the result is information about a topic distributed between the docs and FAQ questions, which ultimately makes the documentation harder to search.
177177

178178
FAQ content, such as lists of most frequently encountered error messages, is still very useful in many contexts.
179179
If you want to add such content, create a section at the bottom of a topic page, for example this section on the [SSH documentation page][ref-ssh-faq].

docs/guides/storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Workloads that do not play nicely with Lustre include:
1212

1313
At first it can seem strange that a "high-performance" file system is significantly slower than a laptop drive for a "simple" task like compilation or loading Python modules, however Lustre is designed for high-bandwidth parallel file access from many nodes at the same time, with the attendant trade offs this implies.
1414

15-
Meta data lookups on Lustre are expensive compared to your laptop, where the local file system is able to agressively cache meta data.
15+
Meta data lookups on Lustre are expensive compared to your laptop, where the local file system is able to aggressively cache meta data.
1616

1717
### Python virtual environments with uenv
1818

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The Alps Research infrastructure hosts multiple platforms and clusters targeting
5353

5454
- :fontawesome-solid-key: __Logging In__
5555

56-
Once you have an account, you can set up multi factor authentification
56+
Once you have an account, you can set up multi factor authentication
5757

5858
[:octicons-arrow-right-24: Setting up MFA][ref-mfa]
5959

0 commit comments

Comments
 (0)