Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
9c554c0
Add Vale testing workflow for pull requests
Amanda-dong Jul 16, 2026
863367f
Update vale-test.yml
Amanda-dong Jul 16, 2026
c58aa67
Update vale-test.yml
Amanda-dong Jul 16, 2026
ba99641
Add Vale configuration file .vale.ini
Amanda-dong Jul 16, 2026
e4c5dea
Create vale-test.mdx
Amanda-dong Jul 16, 2026
6fd8529
Update .vale.ini
Amanda-dong Jul 16, 2026
8baeb3d
Create TitleCase.yml
Amanda-dong Jul 16, 2026
c6d2171
Update 02_data_transfers.md
Amanda-dong Jul 16, 2026
e132a18
Create accept.txt
Amanda-dong Jul 16, 2026
29cb023
Update .vale.ini
Amanda-dong Jul 16, 2026
8056cee
Update .vale.ini
Amanda-dong Jul 16, 2026
4c23eca
Rename accept.txt to accept.txt
Amanda-dong Jul 16, 2026
a312ec6
Rename config/vocabularies/accept.txt to config/vocabularies/RTS/RTS/…
Amanda-dong Jul 16, 2026
c292db2
Rename config/vocabularies/RTS/RTS/accept.txt to config/vocabularies/…
Amanda-dong Jul 16, 2026
f608798
Update vale-test.yml
Amanda-dong Jul 16, 2026
5a1bfa2
Update .vale.ini
Amanda-dong Jul 16, 2026
4be7e29
Update .vale.ini
Amanda-dong Jul 16, 2026
8970c2b
Rename config/vocabularies/RTS/accept.txt to vale-styles/config/vocab…
Amanda-dong Jul 16, 2026
defb288
Update vale-test.yml
Amanda-dong Jul 16, 2026
6d7eae0
Update vale-test.yml
Amanda-dong Jul 16, 2026
9d53049
Update vale-test.yml
Amanda-dong Jul 16, 2026
408c4ce
Update accept.txt
Amanda-dong Jul 16, 2026
9b4dc5f
Update .vale.ini
Amanda-dong Jul 16, 2026
5fabcc6
Update vale-test.yml
Amanda-dong Jul 16, 2026
9dbf9ad
Create vale-reviewdog-test.mdx
Amanda-dong Jul 16, 2026
2ccbdf8
Delete docs/hpc/vale-test.mdx
Amanda-dong Jul 16, 2026
70e1330
Update vale-test.yml
Amanda-dong Jul 17, 2026
435d64f
Update vale-test.yml
Amanda-dong Jul 17, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/workflows/vale-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Vale Test

on:
pull_request:
workflow_dispatch:

permissions:
contents: read
pull-requests: write

jobs:
vale:
name: Vale Grammar and Style Check
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v6

- name: Run Vale
uses: vale-cli/vale-action@v2
with:
version: 3.12.0
files: |
docs/
src/pages/
reporter: github-pr-review
14 changes: 14 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
StylesPath = vale-styles

Vocab = RTS

[formats]
mdx = md

[*.{md,mdx}]
BasedOnStyles = Vale, TitleCase

Vale.Spelling = YES
Vale.Repetition = YES
Vale.Terms = NO
TitleCase.TitleCase = YES
2 changes: 1 addition & 1 deletion docs/hpc/03_storage/02_data_transfers.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ logout

### Linux & Mac Tools

#### `scp` And `rsync`
#### `scp` and `rsync`
:::warning
Please use Data Transfer Nodes (DTNs) with these tools. While one can transfer data while on login nodes, it is considered a bad practice because it can degrade the node's performance.
:::
Expand Down
9 changes: 9 additions & 0 deletions docs/hpc/vale-reviewdog-test.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# vale reviewdog test

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[TitleCase.TitleCase] 'vale reviewdog test' should use title case

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'reviewdog'?


This is is a test.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Repetition] 'is' is repeated!


This sentence has a mispelled word: recieve.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'mispelled'?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'recieve'?


:::warning
This is a warning.
:::
14 changes: 14 additions & 0 deletions vale-styles/TitleCase/TitleCase.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
extends: capitalization
message: "'%s' should use title case"
level: warning
scope: heading
match: $title
style: Chicago
exceptions:
- rclone
- rsync
- HDF5
- LMDB
- SLURM
- GPU
- HPC
289 changes: 289 additions & 0 deletions vale-styles/config/vocabularies/RTS/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,289 @@
HPC
sbatch
rsync
repo
Carahsoft
GCP's
Burwood
GPUs
config
hostname
squeue
vglrun
CPUs
Slurm
scp
NYU's
hadoop
kubernetes
Dataproc
autoscaling
Autoscaling
Dataproc's
lefthand
LLMs
Portkey
Agentic
agentic
langchain
llamaindex
catalouge
chatbots
Colab
ACLs
getfacl
setfacl
gsutil
gcloud
JSONLines
json
hdfs
AMPLab
Trino
Conda
prepopulated
netids
DOIs
XQuartz
walkthrough
debian
linux
sudo
openconnect
sms
PI_One
tandon_advanced
tandon_priority
courant
lpinto
bpeher
lzanna
RTXPro
cds
cilvr
mren
xwang
Powershell
cmd
powershell
exe
Globus
gDTNs
Infiniband
DTNs
sharename
rclone
myquota
inode
inodes
VSCode
RStudio
globus
mfa
png
jpg
lmd
lmdb
Tensorflow
Pytorch
numpy
jpeg
tibble
Bcolz
Zarr
Parallelization
RClone
Rclone
kevin
susie's
susie
synset
synsets
Kaggle
MJSynth
segmentations
Waymo
Apptainer
renv
alphafold
knitro
amd
lammps
slurm
comsol
matlab
mathematica
stata
squashfs
gaussian
vnc
vscode
julia
sas
xvfb
jupyter
schrodinger
preemptible
Preemptible
Lmod
modulefile
Bioinformatics
bioinformatics
srun
salloc
sinfo
squeue
sacct
scancel
ncpus
stdout
stderr
ntasks
nvidia
conda
Nextflow
venv
virtualenv
env
mpi
dplyr
sqlite
row_number
rsqlite
csv
Biologics
Epik
pKa
QSite
subnet
multiphysics
Multiphysics
Comsol
Mathematica
Simulink
Mathworks
Stata
Stata's
initio
Knitro
slurmctld
lockfile
Packrat
vllm
Syslabs
vm
Docker's
penv
line_profiler
profiler
Nsight
multiple_workers
ffcv
ddp
webpages
gpus_per_node
multinode
Keras
gpus
Horovod
MXNet
Miniforge
Preinstallation
Miniconda
bioconda
pytorch
gzipped
nyu
miniforge
nano
readonly
Qwen
APIs
SGLang
img
miniconda
tokenizer
return_tensors
cuda
Laiba
Mehnaz
pretrained
Pretrained
redownloading
Tokenizer
iPython
my_env
JBrowse
bcftools
Xeon
Tandon
Courant
wget
fb
fastq
mkdir
mv
wc
stdin
melanogaster
gzip
zcat
whoami
tempfiles
spacebar
subcolumns
chmod
VPNs
Ctrl
Hostname
Nano
subdir
new_subdir
kevyin
libcurl
dnf
Wget
homebrew
walltime
Greene
fileserver
nproc
lscpu
df
tmp
xfs
zfs
beegfs
cifs
gpfs
nfs
pvfs
subcommand
subcommands
bugfix
bioinformatic
Amdahl
amdahl
Cyberinfrastructure
DUAs
Infographic
requesters
Emeriti
onboarding
formatters
Regexes
parallelization
xyz
du
Solaris
sftp
Quickconnect
data's
scrollable
Storable
matchers
chartfield
Ceph
facl
Qualtrics
netid
Loading