Skip to content

Commit c272a77

Browse files
authored
Merge pull request #398 from SouthernMethodistUniversity/add_accessibility_scanner
Add accessibility scanner
2 parents af7c98b + 9c919f8 commit c272a77

4 files changed

Lines changed: 19 additions & 6 deletions

File tree

.github/workflows/a11y-scan.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,19 @@ jobs:
99
with:
1010
urls: | # Provide a newline-delimited list of URLs to scan; more information below.
1111
https://southernmethodistuniversity.github.io/hpc_docs/
12+
https://southernmethodistuniversity.github.io/hpc_docs/coldfront/qs_instructor.html
13+
https://southernmethodistuniversity.github.io/hpc_docs/coldfront/qs_student.html
14+
https://southernmethodistuniversity.github.io/hpc_docs/coldfront/add_change_project.html
15+
https://southernmethodistuniversity.github.io/hpc_docs/coldfront/add_class.html
16+
https://southernmethodistuniversity.github.io/hpc_docs/coldfront/add_remove_users.html
17+
https://southernmethodistuniversity.github.io/hpc_docs/coldfront/request_change_allocation.html
18+
https://southernmethodistuniversity.github.io/hpc_docs/coldfront/add_metadata.html
19+
https://southernmethodistuniversity.github.io/hpc_docs/coldfront/usage_stats.html
20+
https://southernmethodistuniversity.github.io/hpc_docs/coldfront/archive_project.html
21+
https://southernmethodistuniversity.github.io/hpc_docs/coldfront/renewals.html
22+
https://southernmethodistuniversity.github.io/hpc_docs/coldfront/running_jobs.html
23+
https://southernmethodistuniversity.github.io/hpc_docs/coldfront/faq.html
24+
https://southernmethodistuniversity.github.io/hpc_docs/coldfront/optout.html
1225
repository: "SouthernMethodistUniversity/hpc_docs"
1326
token: ${{ secrets.A11Y_SCAN_ACCESS_TOKEN }}
1427
cache_key: "hpc_docs_a11y_scan" # Provide a filename that will be used when caching results. We recommend including the name or domain of the site being scanned.

docs/_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ sphinx:
2121
numfig: True
2222
numfig_secnum_depth: 0
2323
numfig_format:
24-
code-block: "%s"
24+
code-block: "%s"

docs/tutorials/globus_box_transfers.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,15 @@ Click the start button above the side the data is coming from to start the trans
6666

6767
You may want to adjust the transfer settings (for example, to only update new or changed files)
6868

69-
:::{Note}
69+
:::{note}
7070
You do not have to stay on the Globus site while the transfer is happening. It will send an email when completed.
7171
:::
7272

73-
:::{Note}
73+
:::{note}
7474
The transfers can be slow. We typically see between 1-5 MBPS between Box and M3 (connection speeds to other services may vary).
7575
:::
7676

77-
:::{Note}
77+
:::{note}
7878
Box has a file size limit of 50GB
7979
:::
8080

docs/tutorials/slurm/best_practices.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ $ reportseff -u $USER --since d=1
8080
3575979 CANCELLED 00:00:43 1.2% 14.0% 12.6%
8181
```
8282

83-
:::{Note}
83+
:::{note}
8484
If you command outputs a large number of jobs, the formatting is sometimes not clean.
8585
:::
8686

@@ -100,7 +100,7 @@ If your program is behaving as expected, consider reducing the number of cores y
100100

101101
The memory efficiency represents the percentage of the requested memory that was used by your job. Realistically, anything about `50%` memory efficiency is good. Due to how memory is measured, programs that dynamically allocate and deallocate memory may fail as a result of running out of memory even if the reported usage is "low." If you know your program allocates most of the memory it uses at the beginning, aiming for `80-90%` efficiency is a good target.
102102

103-
:::{Note}
103+
:::{note}
104104
Memory efficiency is hard to measure. SLURM periodically samples memory usage, so it often misses large spikes of increased memory usage that occurs between samples. It is not unsual for jobs to temporarily use 2x or more memory than reported.
105105
:::
106106

0 commit comments

Comments
 (0)