Skip to content

Commit cb39560

Browse files
authored
Various typo and language fixes (#4122)
- Skimmed .md files with aspell --lang=en_US - Miscellaneous wording improvements
1 parent 8487757 commit cb39560

File tree

5 files changed

+23
-23
lines changed

5 files changed

+23
-23
lines changed

ACCESSIBILITY.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ with regard to the WCAG 3.0 standard.
2525

2626
Specifically, it outlines where Open OnDemand does not meet this standard.
2727
It may also link to a ticket that developers track. You can search
28-
[all accessability issues](https://github.com/OSC/ondemand/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Faccessibility)
28+
[all accessibility issues](https://github.com/OSC/ondemand/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Faccessibility)
2929
as well.
3030

3131
## 3rd Party Apps
@@ -40,7 +40,7 @@ are not documented here.
4040
## Accessibility by URL
4141

4242
Each section below documents a single webpage. If the section heading
43-
includes sub URLs this means the same webpage is used to genereate content
43+
includes sub URLs this means the same webpage is used to generate content
4444
based on the URL.
4545

4646
As an example in the section entitled `/pun/sys/dashboard/files and sub URLs`,
@@ -52,9 +52,9 @@ as `/pun/sys/files/fs/home/jessie`.
5252
These issues affect all or most URLs.
5353

5454
- Most URLs have the main navigation bar. This is a list of issues with that navigation
55-
bar. See this issue for [navigation bar accessability issue](https://github.com/OSC/ondemand/issues/945)
55+
bar. See this issue for [navigation bar accessibility issue](https://github.com/OSC/ondemand/issues/945)
5656
for more details.
57-
- Screen readers will see the navigation bar landark as 'banner landmark', 'navigation'
57+
- Screen readers will see the navigation bar landmark as 'banner landmark', 'navigation'
5858
and 'navigation landmark', where really we should only have 1 single landmark.
5959
- Many [alerts don't notify screen readers.](https://github.com/OSC/ondemand/issues/2077)
6060
As an example, when you start an interactive session there's an alert to notify the user
@@ -66,8 +66,8 @@ This is the landing page and what the root URL `/` redirects to.
6666

6767
The landing page allows for site administrators to create panels. The panels we
6868
distribute are covered in this document. Panels specifically created at any
69-
given site are unknown to us (the developers), have not and will not be assesed
70-
for accessability.
69+
given site are unknown to us (the developers), have not and will not be assessed
70+
for accessibility.
7171

7272
- [The welcome logo does not provide alt text.](https://github.com/OSC/ondemand/issues/2067)
7373
- [Message of the Day and pinned apps use heading levels 3 & 4 instead of 2 & 3.](https://github.com/OSC/ondemand/issues/2074).
@@ -80,7 +80,7 @@ for accessability.
8080
There are several issues with batch connect session cards.
8181
- First when they change state, say from 'Queued' to 'Running' there's no notification that this happened.
8282
- Secondly, there's no good organization of these cards. They should probably be in a list.
83-
- Lastly some of the text is off, like the session id link that is a UUID. It's an ambigous link.
83+
- Lastly some of the text is off, like the session id link that is a UUID. It's an ambiguous link.
8484

8585
#### Batch connect app web forms
8686

@@ -95,8 +95,8 @@ may have included.
9595
- [Dynamic form updates do not update the user.](https://github.com/OSC/ondemand/issues/2075) When a
9696
user updates a form field, another form field may automatically be updated. There is no screen reader
9797
notification when this occurs.
98-
- [Resolution fields don't have the right labels.](https://github.com/OSC/ondemand/issues/2076) Resulution
99-
form fields have labels visible to sigted users, but screen-reader navigation does not automatically read
98+
- [Resolution fields don't have the right labels.](https://github.com/OSC/ondemand/issues/2076) Resolution
99+
form fields have labels visible to sighted users, but screen-reader navigation does not automatically read
100100
them. The user is forced to navigate around the form element to hear the label.
101101

102102
### /pun/sys/dashboard/noVNC-1.1.0/vnc.html
@@ -115,7 +115,7 @@ where we come to this conclusion.
115115
- [The files table does not notify users of updates](https://github.com/OSC/ondemand/issues/2080).
116116
When a user clicks through to another directory in the file browser table the table updates
117117
with the contents of the chosen directory. However, screen-readers are not notified that this
118-
change has occured.
118+
change has occurred.
119119
- [Screen-Readers read the sorting arrows in the files table](https://github.com/OSC/ondemand/issues/2081)
120120
when they should only read the column name.
121121
- [File browsing landmarks could be better.](https://github.com/OSC/ondemand/issues/2079) There's
@@ -125,12 +125,12 @@ where we come to this conclusion.
125125

126126
The shell application is considered completely inaccessible. Screen
127127
readers do work on it a little, but it's so little as to be rendered
128-
completey useless.
128+
completely useless.
129129

130130
The underlying library `hterm` does have support for accessibility but
131131
we need some mechanism to turn it on.
132132

133-
We have this ticket concerning [shell accessability](https://github.com/OSC/ondemand/issues/672)
133+
We have this ticket concerning [shell accessibility](https://github.com/OSC/ondemand/issues/672)
134134
to tracks this.
135135

136136
### /pun/sys/myjobs and sub URLs

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Ensure to include what issue this fixes in the **PR comment** to help with autom
121121

122122
### Linters
123123

124-
For any Ruby librares/apps there is a `.rubocop.yml` at the top of this project. If you
124+
For any Ruby libraries/apps there is a `.rubocop.yml` at the top of this project. If you
125125
work in IDEs where you want to only open a part of this project, executing `rake lint:setup`
126126
and it will copy copy lint config files to various locations. Watch out though, `rake clean`
127127
will remove them!
@@ -155,7 +155,7 @@ methods.
155155
* avoid using semi-colons `;`
156156
* Spaces:
157157
* around operators `=`, `+`, `-`, `*`, `%`
158-
* around curly bracies `{` `}`
158+
* around curly braces `{` `}`
159159
* after commas , colons, and semicolons
160160

161161
```ruby
@@ -175,7 +175,7 @@ methods.
175175
end
176176
```
177177

178-
* Empty line between method defintions.
178+
* Empty line between method definitions.
179179

180180
```ruby
181181
def method1(arg1)
@@ -406,7 +406,7 @@ function snakeCaseWords(str) {
406406

407407
Beyond the [ESLint] configuration files, we follow these styles:
408408

409-
* File names use underscores, `_`, for word seperators.
409+
* File names use underscores, `_`, for word separators.
410410
* Variables are `camelCase` named and are `const` or `let`. Using `var` is discouraged.
411411
* Function names are `camelCase`.
412412

@@ -415,13 +415,13 @@ Beyond the [ESLint] configuration files, we follow these styles:
415415
In general, when making html elements (or Ruby/Js/Etc models of)
416416
we'll follow this style.
417417
418-
* IDs use underscores `_` for word seperation. This follows the Rails `form_for` convention.
418+
* IDs use underscores `_` for word separation. This follows the Rails `form_for` convention.
419419
420420
421421
### CSS Style
422422
423423
* Applicable SCSS conventions like hyphenated variables and those variables are in the `_variables.scss` file.
424-
* class names use hyphens, `-` for word seperators. If for no other reason than to follow bootstrap
424+
* class names use hyphens, `-` for word separators. If for no other reason than to follow bootstrap
425425
which we use quite extensively.
426426
* classes should mostly use relative sizes (`em` and `rem`), rarely pixel values (`px`).
427427

DEVELOPMENT.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Developing Open-OnDemand
1+
# Developing Open OnDemand
22

33
This a a guide to developing Open OnDemand.
44

@@ -57,7 +57,7 @@ However, you may choose to have a different development runtime, and that's fine
5757
OSC maintainers use `modules` on compute nodes instead of developing on the webnodes
5858
themselves.
5959

60-
It should be noted here that any Ruby module installation needs configured with
60+
It should be noted here that any Ruby module installation needs to be configured with
6161
`--enable-shared` flag to be compatible with the Ruby running on the webnode.
6262

6363
Now run `bin/setup` from within this directory to fetch all the dependencies
@@ -227,7 +227,7 @@ variables you may want and/or need.
227227
For example if you need additional Linux capabilities you can use `OOD_CTR_CAPABILITIES`
228228
with a comma separated list of the capabilities you want.
229229

230-
If `privileged` is in this list, no capabilies are used and the container is ran with
230+
If `privileged` is in this list, no capabilities are used and the container is ran with
231231
the `--privileged` flag.
232232

233233
```shell

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Open OnDemand is an NSF-funded open-source HPC portal. The goal of Open OnDemand
3030
![Open ondemand demo demonstrating integration with Open XDMOD; interactive jobs with desktops, Jupyter and visual studio code; file browsing, creation, editing and deletion.](docs/imgs/open_ondemand_demo.gif)
3131

3232
## Installation
33-
Installing Open OnDemand simple, use our `.rpm` or `.deb` packages. Get started by visiting the [installation instructions] in our documentation.
33+
Installing Open OnDemand is simple, use our `.rpm` or `.deb` packages. Get started by visiting the [installation instructions] in our documentation.
3434

3535
### Container demos
3636

VERSIONING_POLICY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Minor versions will contain new functionality that's backward compatible. They m
1616
also contain bug fixes that are not in the prior releases' patch versions.
1717

1818
Minor versions will also introduce deprecations to functionality or configurations
19-
that maybe be removed in the next major version.
19+
that may be removed in the next major version.
2020

2121
## Patch Versions
2222
Patch versions will only contain security fixes and bug fixes.

0 commit comments

Comments
 (0)