pyspelling instructions (2i2c-org#21)

.custom-dictionary.txt

@@ -0,0 +1,119 @@
+Dask
+Jupyter
+JupyterHub
+PyData
+analytics
+customizable
+dask
+githubusercontent
+html
+https
+hublogo
+io
+jupyter
+jupyterbook
+jupyterlab
+nav
+numfocus
+png
+pydata
+readthedocs
+src
+svg
+toolchain
+btn
+callout
+ref
+href
+RStudio
+VSCode
+fas
+featurette
+scalable
+sourcethemes
+calc
+cta
+img
+jpg
+px
+url
+vh
+Config
+Gravatar
+UC
+berkeley
+edu
+fernando
+mailto
+perez
+url
+FAIpQLSdW
+KQPILbU
+Netlify
+SXg
+autolink
+bhVrXfgRYa
+formspree
+frameborder
+iframe
+marginheight
+marginwidth
+nKUF
+tgnGZJbs
+viewform
+Uncomment
+BinderHubs
+JupyterHubs
+Pangeo
+datasets
+geoscience
+pangeo
+PIMS
+Syzygy
+pims
+syzygy
+wordmark
+jupyterhub
+DataHubs
+datahubs
+ds
+github
+Callysto
+Colour
+Cybera
+Hor
+PIMS
+callysto
+wp
+Kubernetes
+Mybinder
+mybinder
+repo
+sharable
+Yuvi
+yuvi
+Colliander
+colliander
+jim
+www
+Heagy
+heagy
+lindsey
+lindseyjh
+Holdgraf
+choldgraf
+chris
+holdgraf
+impactful
+neuroscience
+carson
+cathryn
+http
+icsi
+www
+dev
+funder
+c's
+ucbds
+abernathy
+ryan

.gitignore

@@ -1,2 +1,3 @@
 resources
 public
+custom-dictionary.dic

.pyspelling.yml

@@ -0,0 +1,12 @@
+matrix:
+- name: markdown
+  pipeline:
+  - pyspelling.filters.text
+  sources:
+  - 'content/**/*.md'
+  default_encoding: utf-8
+  dictionary:
+    wordlists:
+    - .custom-dictionary.txt
+    output: custom-dictionary.dic
+    encoding: utf-8

README.md

@@ -23,6 +23,35 @@ It is built from the [academic hugo theme].
   ```
 * Push your changes to the repository and Netlify will automatically update the website.
 
+## Check the spelling of any pages
+
+This repository is configured with [the pyspelling package](https://facelessuser.github.io/pyspelling/). It will analyze all of the markdown files in `content/` and tell you if there are any un-recognized words.
+
+To use `pyspelling`, first install it:
+
+```
+pip install pyspelling
+```
+
+Then install the `aspell` package:
+
+```
+sudo apt-get install aspell
+```
+
+Finally, you can run `pyspelling` on the repository like so:
+
+```
+pyspelling
+```
+
+Note that pyspelling may find some errors that are simply un-recognized, but correct, words. For example, HTML elements. To make these errors pass, you can add them to the list of custom spelling words here:
+
+`.custom-dictionary.txt`.
+
+For more information, see [the `pyspelling` documentation](https://facelessuser.github.io/pyspelling/).
+
+
 ## This website's theme
 
 We are using the latest version of the [Wowchemy theme](https://wowchemy.com/docs/) (used to be the "Academic Theme"). See its documentation for information about customization and usage.

content/founders/intro.md

@@ -11,4 +11,4 @@ title = "Our founding team"
 
 2i2c is founded by leaders in the research, education, and open source community. We have [years of experience in deploying infrastructure for interactive computing](#projects), as well as integrating that infrastructure into institutional pedagogy and research efforts. In addition, we are core contributors to many large open source projects in the Jupyter community.
 
-We created 2i2c because of the successes that we witnessed at our institutions in empowering reserach and improving education through interactive computing. 2i2c is an attempt at bringing that success to the broader research and education community by providing expertise, development, and support for open source tools in interactive computing in the cloud.
+We created 2i2c because of the successes that we witnessed at our institutions in empowering research and improving education through interactive computing. 2i2c is an attempt at bringing that success to the broader research and education community by providing expertise, development, and support for open source tools in interactive computing in the cloud.

content/infrastructure/2i2c-hub-overview.md

@@ -5,7 +5,7 @@ weight = 25
 +++
 # What is in a 2i2c Hub?
 
-A 2i2c Hub is a collection of open source tools that provide interactive computing environments in the cloud. JupyterHub is the lynchpin that ties everything together. It handles user accounts, provides the interactive environment, and connects users with computational and data resources.
+A 2i2c Hub is a collection of open source tools that provide interactive computing environments in the cloud. JupyterHub is the lynch-pin that ties everything together. It handles user accounts, provides the interactive environment, and connects users with computational and data resources.
 
 Every 2i2c Hub is tailored for the community that uses it. 2i2c Hubs can run on almost any kind of cloud infrastructure (or even your own local hardware), provide a customizable environment for your needs, and they are built with 100% open source and community-driven software.
 

content/open-source/benefits.md

@@ -14,5 +14,5 @@ Using open infrastructure has several advantages:
 - **Powerful, flexible, and dynamic**. Open source tools are the best for accelerating research and empowering improving education.
 - **Flexibility and freedom**. Open source tools run on many kinds of infrastructure and to avoid vendor lock-in. You can run the entire 2i2c stack on your own if you wish!
 - **Standards in data science**. Open source tools are the most-common toolchain across all research fields as well as outside of academia.
-- **Align with your values**. Open source tools are controlled and owned by a broad and divverse community that is dedicated to the public good.
+- **Align with your values**. Open source tools are controlled and owned by a broad and diverse community that is dedicated to the public good.
 - **Accessible to all**. Open tools are free to use and deploy, making research and education more accessible to people around the world.