diff --git a/.github/workflows/vale-test.yml b/.github/workflows/vale-test.yml new file mode 100644 index 0000000000..6a2efb9cf9 --- /dev/null +++ b/.github/workflows/vale-test.yml @@ -0,0 +1,25 @@ +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 diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000000..ec3a21004c --- /dev/null +++ b/.vale.ini @@ -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 diff --git a/docs/hpc/03_storage/02_data_transfers.md b/docs/hpc/03_storage/02_data_transfers.md index 5152b80881..7604b4516a 100644 --- a/docs/hpc/03_storage/02_data_transfers.md +++ b/docs/hpc/03_storage/02_data_transfers.md @@ -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. ::: diff --git a/docs/hpc/vale-reviewdog-test.mdx b/docs/hpc/vale-reviewdog-test.mdx new file mode 100644 index 0000000000..a27214e55e --- /dev/null +++ b/docs/hpc/vale-reviewdog-test.mdx @@ -0,0 +1,9 @@ +# vale reviewdog test + +This is is a test. + +This sentence has a mispelled word: recieve. + +:::warning +This is a warning. +::: diff --git a/vale-styles/TitleCase/TitleCase.yml b/vale-styles/TitleCase/TitleCase.yml new file mode 100644 index 0000000000..d18b353e95 --- /dev/null +++ b/vale-styles/TitleCase/TitleCase.yml @@ -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 diff --git a/vale-styles/config/vocabularies/RTS/accept.txt b/vale-styles/config/vocabularies/RTS/accept.txt new file mode 100644 index 0000000000..89d2c44696 --- /dev/null +++ b/vale-styles/config/vocabularies/RTS/accept.txt @@ -0,0 +1,314 @@ +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 +Linux +Single-GPU +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 +SQLite +SQLiteStudio +UI +multithreaded +namd +MacOS +Anthropic +VertexAI +Jupyter +reauthentication +whatis +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 +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 +snapshotting +non-Windows +Instruction-tuned +Fine-tuning +Matlab-Proxy +Lua +Multi-node +TensorFlow +nonconvex +Non-NYU +Scaling