Fix typos, half sentences and some capitalization
MODIFY
CONTRIBUTING.md
CONTRIBUTING.md
@@ -210,7 +210,7 @@ individuals to be responsible and tread softly when doing so. Below a few
standard procedures that have proven useful over time that we do follow:
* do not merge your own PR
-* wait for travis to complete
+* wait for Travis to complete
* check if test coverage has gone up or down, consider discussing additional
tests to keep coverage at the same level or even increase it
* do use merge commits instead of merge-by-squashing/-rebasing. This makes it
@@ -229,7 +229,7 @@ To release repo2docker, you will need proper access credentials prior to beginni
1. Access to the PyPI package for repo2docker
2. Access to push tags to the jupyter/repo2docker repository
-3. Acess to push images to dockerhub on jupyter/repo2docker
+3. Access to push images to dockerhub on jupyter/repo2docker
If you do not have access to any of these, please contact a current maintainer of the project!

MODIFY
README.md
README.md
@@ -9,7 +9,7 @@ repository. It then builds, runs, and/or pushes Docker images built from that so
See the [repo2docker documentation](http://repo2docker.readthedocs.io)
for more information.
-## Pre-requisites
+## Prerequisites
1. Docker to build & run the repositories. The [community edition](https://store.docker.com/search?type=edition&offering=community)
is recommended.
@@ -35,7 +35,7 @@ pip install -e .
## Usage
-The core feature of repo2docker is to fetch a repository (from github or locally),
+The core feature of repo2docker is to fetch a repository (from GitHub or locally),
build a container image based on the specifications found in the repository &
optionally launch a local Jupyter Notebook you can use to explore it.

MODIFY
docs/source/deploy.rst
docs/source/deploy.rst
@@ -79,7 +79,7 @@ Step 4. Connect to CircleCI
If you navigate to the main `app page <https://circleci.com/dashboard/>`_ you
should be able to click "Add Projects" and then select your repository. If you don't
see it on the list, then select a different organization in the top left. Once
-you find the repository, you can click the button to "Start Building" adn accept
+you find the repository, you can click the button to "Start Building" and accept
the defaults.
Before you push or trigger a build, let's set up the following environment variables.

MODIFY
docs/source/design.md
docs/source/design.md
@@ -7,7 +7,7 @@ The philosophy for the repo2docker buildpacks includes:
- using common configuration files for familiar installation and packaging tools
- allowing configuration files to be combined to compose more complex setups
- specifying default locations for configuration files
-(repo's root directory or .binder directory)
+(the repository's root directory or .binder directory)
When designing `repo2docker` and adding to it in the future, the
@@ -57,7 +57,7 @@ Bionic Beaver (18.04).
The version of `repo2docker` used to build an image can influence which packages
are installed by default and which features are supported during the build
process. We will periodically update those packages to keep step with releases
-of jupyter notebook, jupyterlab, etc. For packages that are installed by
+of Jupyter Notebook, JupyterLab, etc. For packages that are installed by
default but where you want to control the version we recommend you specify them
explicitly in your dependencies.

MODIFY
docs/source/dev_newbuildpack.md
docs/source/dev_newbuildpack.md
@@ -12,15 +12,15 @@ Criteria to balance are:
2. How easy it is to use a given setup without support from repo2docker natively.
There are two escape hatches here - `postBuild` and `Dockerfile`.
3. How widely used is this language / package manager? This is the primary tradeoff
- with point (1). We (Binder / Jupyter) team do not want to make new formats
- as much as possible, so ideally we can just say 'X repos on binder already use
+ with point (1). We (the Binder / Jupyter team) want to make new formats
+ as little as possible, so ideally we can just say "X repositories on binder already use
this using one of the escape hatches in (2), so let us make it easy and add
- native support'.
+ native support".
## Adding libraries or UI to existing buildpacks
Note that this doesn't apply to adding additional libraries / UI to existing
buildpacks. For example, if we had an R buildpack and it supported IRKernel,
it is much easier to
-just support RStudio / Shiny with it, since those are library additions than entirely
+just support RStudio / Shiny with it, since those are library additions instead of entirely
new buildpacks.

MODIFY
docs/source/faq.md
docs/source/faq.md
@@ -33,5 +33,5 @@ Dockerfile, and is meant to be built in
Hence the output of `--debug` can not be built with a normal `docker build -t .`
or similar traditional docker command.
-Check out the [binder-examples](http://github.com/binder-examples/) github
+Check out the [binder-examples](http://github.com/binder-examples/) GitHub
organization for example repositories you can copy & modify for your own use!

MODIFY
docs/source/install.rst
docs/source/install.rst
@@ -29,7 +29,7 @@ We recommend installing ``repo2docker`` with the ``pip`` tool::
python3 -m pip install jupyter-repo2docker
-For infomation on using ``repo2docker``, see :ref:`usage`.
+For information on using ``repo2docker``, see :ref:`usage`.
Installing from source code
---------------------------
@@ -69,10 +69,10 @@ Docker images that can be shared within a JupyterHub deployment. For example,
to allow anyone to build a Docker image of a git repository online and
share an executable version of the repository with a URL to the built image.
-To build JupyterHub_-ready
-Docker images with ``repo2docker``, the version of your JupterHub deployment
-must be included in the ``environment.yml`` or ``requiements.txt`` of the
-git repositories you build.
+To build JupyterHub_-ready Docker images with ``repo2docker``, the
+version of your JupterHub deployment must be included in the
+``environment.yml`` or ``requirements.txt`` of the git repositories you
+build.
If your instance of JupyterHub uses ``DockerSpawner``, you will need to set its
command to run ``jupyterhub-singleuser`` by adding this line in your

MODIFY
docs/source/usage.rst
docs/source/usage.rst
@@ -12,7 +12,7 @@ order to run ``repo2docker``. For more information on installing
1. builds a Docker image from a git repo
2. runs a Jupyter server within the image to explore the repository
-To ensure you can run the software in your repository, you must
+.. To ensure you can run the software in your repository, you must
repo2docker is called with this command::
@@ -31,8 +31,8 @@ specify the ``branch-name`` or ``commit-hash``::
jupyter-repo2docker https://github.com/norvig/pytudes --ref 9ced85dd9a84859d0767369e58f33912a214a3cf
.. tip::
- For reproducibile research, we recommend specifying a commit-hash to
- deterministcally build a fixed version of a repository. Not specifying a
+ For reproducible research, we recommend specifying a commit-hash to
+ deterministically build a fixed version of a repository. Not specifying a
commit-hash will result in the latest commit of the repository being built.
Building the image may take a few minutes.

Fix typos, half sentences and some capitalization