adding spell checking to ci! (#367)

Signed-off-by: vsoch <[email protected]>
Co-authored-by: vsoch <[email protected]>

.github/workflows/main.yml

@@ -13,6 +13,11 @@ jobs:
     steps:
       - uses: actions/checkout@v1
 
+      - name: Check for typos in docs
+        uses: crate-ci/typos@592b36d23c62cb378f6097a292bc902ee73f93ef # version 1.0.4
+        with: 
+          files: ./docs ./README.md
+
       - name: Setup black linter
         run: conda create --quiet --name black black
 

_typos.toml

@@ -0,0 +1,2 @@
+[default.extend-identifiers]
+smoe = "smoe"

docs/_docs/accounts/README.md

@@ -10,7 +10,7 @@ permalink: docs/accounts/
 Singularity Registry server creates user accounts by way of login with OAuth2, and
 then interaction with the API via user specific tokens. These sections describe
 how to generate accounts, teams, as well as robot users for interacting with 
-continous integration.
+continuous integration.
 
  - [credentials](credentials): overview of basic accounts and credentials
  - [robot users](robots) how to create a simple robot user account (admin required)

docs/_docs/install/server.md

@@ -9,7 +9,7 @@ Before doing `docker-compose up -d` to start the containers, there are some spec
 
 ## Under Maintenance Page
 
-If it's ever the case that the Docker images need to be brought down for maintenance, a static fallback page should be available to notify the user. If you noticed in the [prepare_instance.sh](https://github.com/singularityhub/sregistry/blob/master/scripts/prepare_instance.sh) script, one of the things we installed is nginx (on the instance). This is because we need to use it to get proper certificates for our domain (for https). Before you do this, you might want to copy the index that we've provided to replace the default (some lame page that says welcome to Nginx!) to one that you can show when the server is undergoing maintainance.
+If it's ever the case that the Docker images need to be brought down for maintenance, a static fallback page should be available to notify the user. If you noticed in the [prepare_instance.sh](https://github.com/singularityhub/sregistry/blob/master/scripts/prepare_instance.sh) script, one of the things we installed is nginx (on the instance). This is because we need to use it to get proper certificates for our domain (for https). Before you do this, you might want to copy the index that we've provided to replace the default (some lame page that says welcome to Nginx!) to one that you can show when the server is undergoing maintenance.
 
 ```bash
 cp $INSTALL_ROOT/sregistry/scripts/nginx-index.html /var/www/html/index.html
@@ -33,7 +33,7 @@ you'll find a section for domain names, and other metadata about your registry.
 this to be a custom hostname that you use, and custom names and unique resource identifiers for your
 registry. For example, if you have a Google Domain and are using Google Cloud, you should be able to set it up using [Cloud DNS](https://console.cloud.google.com/net-services/dns/api/enable?nextPath=%2Fzones&project=singularity-static-registry&authuser=1). Usually this means
 creating a zone for your instance, adding a Google Domain, and copying the DNS records for
-the domain into Google Domains. Sometimes it can take a few days for changes to propogate.
+the domain into Google Domains. Sometimes it can take a few days for changes to propagate.
 You are strongly encouraged to register both `your.domain.com`, as well as `www.your.domain.com` and have them point to the same IP address.
 We will discuss setting up https in a later section.
 

docs/_docs/introduction.md

@@ -10,7 +10,7 @@ toc: false
 
 Using computational methods to answer scientific questions of interest is an important task to increase our knowledge about the world. Along with careful assembly of protocol and relevant datasets, the scientist must also write software to perform the analysis, and use the software in combination with data to answer the question of interest. When a result of interest to the larger community is found, the scientist writes it up for publication in a scientific journal. This is what we might call a single scientific result.
 
-Replication of a result would increase our confidence in the finding. The extent to which a published finding affords a second scientist to repeat the steps to achieve the result is called reproducibility. Reproducibility, in that it allows for repeated testing of an interesting question to validate knowledge about the world, is a foundation of science. While the original research can be an arduous task, often the culmination of years of work and committment, attemps to reproduce a series of methods to assess if the finding replicates is equally challenging. The researcher must minimally have enough documentation to describe the original data and detailed methods to put together an equivalent experiment. A comparable computational environment must then be used to look for evidence to assert or reject the original hypothesis.
+Replication of a result would increase our confidence in the finding. The extent to which a published finding affords a second scientist to repeat the steps to achieve the result is called reproducibility. Reproducibility, in that it allows for repeated testing of an interesting question to validate knowledge about the world, is a foundation of science. While the original research can be an arduous task, often the culmination of years of work and commitment, attempts to reproduce a series of methods to assess if the finding replicates is equally challenging. The researcher must minimally have enough documentation to describe the original data and detailed methods to put together an equivalent experiment. A comparable computational environment must then be used to look for evidence to assert or reject the original hypothesis.
 
 Unfortunately, many scientists are not able to provide the minimum product to allow others to reproduce their work. It could be an issue of time - the modern scientist is burdened with writing grants, managing staff, and fighting for tenure. It could be an issue of education. Graduate school training is heavily focused on a particular domain of interest, and developing skills to learn to program, use version control, and test is outside the scope of the program. It might also be entirely infeasible. If the experiments were run on a particular supercomputer and/or with a custom software stack, it is a non trivial task to provide that environment to others. The inability to easily share environments and software serves as a direct threat to scientific reproducibility.
 
@@ -129,7 +129,7 @@ The registry automatically parses these labels, and makes them searchable for th
 <br>
 ![../assets/img/labels.png](../assets/img/labels.png)
 <br>
-When you investiage an individual label, you can see all containers in the registry that have it! For example, here I reveal that my testing images are in fact the same image named differently, or at least they have two unique sizes:
+When you investigate an individual label, you can see all containers in the registry that have it! For example, here I reveal that my testing images are in fact the same image named differently, or at least they have two unique sizes:
 <br>
 ![../assets/img/label_single.png](../assets/img/label_single.png)
 

docs/_docs/plugins/README.md

@@ -59,7 +59,7 @@ A plugin mentioned here is added to `INSTALLED_APPS` at runtime, and any `AUTHEN
 and `CONTEXT_PROCESSORS` listed in the plugin `__init.py__` is merged into the project settings.
 
 More documentation will be added as the plugin interface is developed. For now, see plugins
-distrubuted with sregisty under `shub/plugins` for example code.
+distributed with sregisty under `shub/plugins` for example code.
 
 Besides, if your plugin has any specific software requirements that are not currently available in the Docker image and **those requirements are compatible with the current software**, you can set a new build argument `ENABLE_{PLUGIN_NAME}` and add the corresponding installation commands in the `PLUGINS` section of the Dockerfile with the following format:
 ```bash

docs/_docs/plugins/ldap/README.md

@@ -65,7 +65,7 @@ With this command we are:
 
   - Allowing access on port 389 (unecrypted LDAP / StartTLS encrypted)
   - Creating a directory that will have a `basedn: dc=my-company,dc=com`. The
-    basedn is the root of the LDAP directory tree. It is usally created by
+    basedn is the root of the LDAP directory tree. It is usually created by
     breaking your domain name into domain components (dc).
   - Creating an admin account, which will have the dn (distinguished name)
     `cn=admin,dc=my-company,dc=com` and password `avocados`.