Skip to content

Commit 32b3f57

Browse files
committed
Fix typos, half sentences and some capitalization
1 parent 0d78f48 commit 32b3f57

File tree

8 files changed

+20
-20
lines changed

8 files changed

+20
-20
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ individuals to be responsible and tread softly when doing so. Below a few
210210
standard procedures that have proven useful over time that we do follow:
211211
212212
* do not merge your own PR
213-
* wait for travis to complete
213+
* wait for Travis to complete
214214
* check if test coverage has gone up or down, consider discussing additional
215215
tests to keep coverage at the same level or even increase it
216216
* 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
229229
230230
1. Access to the PyPI package for repo2docker
231231
2. Access to push tags to the jupyter/repo2docker repository
232-
3. Acess to push images to dockerhub on jupyter/repo2docker
232+
3. Access to push images to dockerhub on jupyter/repo2docker
233233
234234
If you do not have access to any of these, please contact a current maintainer of the project!
235235

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ repository. It then builds, runs, and/or pushes Docker images built from that so
99
See the [repo2docker documentation](http://repo2docker.readthedocs.io)
1010
for more information.
1111

12-
## Pre-requisites
12+
## Prerequisites
1313

1414
1. Docker to build & run the repositories. The [community edition](https://store.docker.com/search?type=edition&offering=community)
1515
is recommended.
@@ -35,7 +35,7 @@ pip install -e .
3535

3636
## Usage
3737

38-
The core feature of repo2docker is to fetch a repository (from github or locally),
38+
The core feature of repo2docker is to fetch a repository (from GitHub or locally),
3939
build a container image based on the specifications found in the repository &
4040
optionally launch a local Jupyter Notebook you can use to explore it.
4141

docs/source/deploy.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Step 4. Connect to CircleCI
7979
If you navigate to the main `app page <https://circleci.com/dashboard/>`_ you
8080
should be able to click "Add Projects" and then select your repository. If you don't
8181
see it on the list, then select a different organization in the top left. Once
82-
you find the repository, you can click the button to "Start Building" adn accept
82+
you find the repository, you can click the button to "Start Building" and accept
8383
the defaults.
8484

8585
Before you push or trigger a build, let's set up the following environment variables.

docs/source/design.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The philosophy for the repo2docker buildpacks includes:
77
- using common configuration files for familiar installation and packaging tools
88
- allowing configuration files to be combined to compose more complex setups
99
- specifying default locations for configuration files
10-
(repo's root directory or .binder directory)
10+
(the repository's root directory or .binder directory)
1111

1212

1313
When designing `repo2docker` and adding to it in the future, the
@@ -57,7 +57,7 @@ Bionic Beaver (18.04).
5757
The version of `repo2docker` used to build an image can influence which packages
5858
are installed by default and which features are supported during the build
5959
process. We will periodically update those packages to keep step with releases
60-
of jupyter notebook, jupyterlab, etc. For packages that are installed by
60+
of Jupyter Notebook, JupyterLab, etc. For packages that are installed by
6161
default but where you want to control the version we recommend you specify them
6262
explicitly in your dependencies.
6363

docs/source/dev_newbuildpack.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ Criteria to balance are:
1212
2. How easy it is to use a given setup without support from repo2docker natively.
1313
There are two escape hatches here - `postBuild` and `Dockerfile`.
1414
3. How widely used is this language / package manager? This is the primary tradeoff
15-
with point (1). We (Binder / Jupyter) team do not want to make new formats
16-
as much as possible, so ideally we can just say 'X repos on binder already use
15+
with point (1). We (the Binder / Jupyter team) want to make new formats
16+
as little as possible, so ideally we can just say "X repositories on binder already use
1717
this using one of the escape hatches in (2), so let us make it easy and add
18-
native support'.
18+
native support".
1919

2020
## Adding libraries or UI to existing buildpacks
2121

2222
Note that this doesn't apply to adding additional libraries / UI to existing
2323
buildpacks. For example, if we had an R buildpack and it supported IRKernel,
2424
it is much easier to
25-
just support RStudio / Shiny with it, since those are library additions than entirely
25+
just support RStudio / Shiny with it, since those are library additions instead of entirely
2626
new buildpacks.

docs/source/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,5 @@ Dockerfile, and is meant to be built in
3333
Hence the output of `--debug` can not be built with a normal `docker build -t .`
3434
or similar traditional docker command.
3535

36-
Check out the [binder-examples](http://github.com/binder-examples/) github
36+
Check out the [binder-examples](http://github.com/binder-examples/) GitHub
3737
organization for example repositories you can copy & modify for your own use!

docs/source/install.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ We recommend installing ``repo2docker`` with the ``pip`` tool::
2929

3030
python3 -m pip install jupyter-repo2docker
3131

32-
For infomation on using ``repo2docker``, see :ref:`usage`.
32+
For information on using ``repo2docker``, see :ref:`usage`.
3333

3434
Installing from source code
3535
---------------------------
@@ -69,10 +69,10 @@ Docker images that can be shared within a JupyterHub deployment. For example,
6969
to allow anyone to build a Docker image of a git repository online and
7070
share an executable version of the repository with a URL to the built image.
7171

72-
To build JupyterHub_-ready
73-
Docker images with ``repo2docker``, the version of your JupterHub deployment
74-
must be included in the ``environment.yml`` or ``requiements.txt`` of the
75-
git repositories you build.
72+
To build JupyterHub_-ready Docker images with ``repo2docker``, the
73+
version of your JupterHub deployment must be included in the
74+
``environment.yml`` or ``requirements.txt`` of the git repositories you
75+
build.
7676

7777
If your instance of JupyterHub uses ``DockerSpawner``, you will need to set its
7878
command to run ``jupyterhub-singleuser`` by adding this line in your

docs/source/usage.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ order to run ``repo2docker``. For more information on installing
1212
1. builds a Docker image from a git repo
1313
2. runs a Jupyter server within the image to explore the repository
1414

15-
To ensure you can run the software in your repository, you must
15+
.. To ensure you can run the software in your repository, you must
1616
1717
repo2docker is called with this command::
1818

@@ -31,8 +31,8 @@ specify the ``branch-name`` or ``commit-hash``::
3131
jupyter-repo2docker https://github.com/norvig/pytudes --ref 9ced85dd9a84859d0767369e58f33912a214a3cf
3232

3333
.. tip::
34-
For reproducibile research, we recommend specifying a commit-hash to
35-
deterministcally build a fixed version of a repository. Not specifying a
34+
For reproducible research, we recommend specifying a commit-hash to
35+
deterministically build a fixed version of a repository. Not specifying a
3636
commit-hash will result in the latest commit of the repository being built.
3737

3838
Building the image may take a few minutes.

0 commit comments

Comments
 (0)