Merge pull request #505 from betatim/docs-fixup

Fix typos and syntax errors in the documentation

docs/source/config_files.rst

@@ -113,13 +113,13 @@ used for your R installation.
 It is powered by the open file format `Dar <https://github.com/substance/dar>`_.
 
 If your repository contains a Stencila document, repo2docker detects it based on the file ``manifest.xml``.
-The required `execution contexts <https://stenci.la/learn/intro.html>` are extracted from a Dar article (i.e.
+The required `execution contexts <https://stenci.la/learn/intro.html>`_ are extracted from a Dar article (i.e.
 files named ``*.jats.xml``).
 
 You may also have a ``runtime.txt`` and/or an ``install.R`` to manually configure your R installation.
 
 To see example repositories, visit our
-`Stencila with R <https://github.com/binder-examples/stencila-r/>`_ and 
+`Stencila with R <https://github.com/binder-examples/stencila-r/>`_ and
 `Stencila with Python <https://github.com/binder-examples/stencila-py>`_ examples.
 
 .. _postBuild:
@@ -141,9 +141,9 @@ their demo for binder <https://github.com/jupyterlab/jupyterlab-demo/blob/master
 ====================================================
 
 A script that can contain simple commands to be run at runtime (as an
-`ENTRYPOINT <https://docs.docker.com/engine/reference/builder/#entrypoint>`
+`ENTRYPOINT <https://docs.docker.com/engine/reference/builder/#entrypoint>`_
 to the docker container). If you want this to be a shell script, make sure the
-first line is ```#!/bin/bash``. The last line must be ```exec "$@"```
+first line is ``#!/bin/bash``. The last line must be ``exec "$@"``
 equivalent.
 
 Use this to set environment variables that software installed in your container

docs/source/contributing/contributing.md

@@ -18,8 +18,8 @@ repo2docker merged.
 
 ## Guidelines to getting a Pull Request merged
 
-These are not hard rules to be enforced by :police_car: but instead guidelines
-to help you make the most effictive / efficient contribution.
+These are not hard rules to be enforced by 🚓 but instead guidelines
+to help you make a contribution.
 
 * prefix the title of your pull request with `[MRG]` if the contribution
   is complete and should be subjected to a detailed review;
@@ -31,6 +31,7 @@ to help you make the most effictive / efficient contribution.
 * describe why you are proposing the changes you are proposing;
 * try to not rush changes (the definition of rush depends on how big your
   changes are);
+* Enter your changes into the [change log](https://github.com/jupyter/repo2docker/blob/master/CHANGES.rst);
 * someone else has to merge your PR;
 * new code needs to come with a test;
 * apply [PEP8](https://www.python.org/dev/peps/pep-0008/) as much
@@ -67,7 +68,7 @@ make that your current directory with `cd repo2docker`.
 
 After cloning the repository (or your fork of the repository), you should set up an
 isolated environment to install libraries required for running / developing
-repo2docker. 
+repo2docker.
 
 There are many ways to do this but here we present you with two approaches: `virtual environment` or `pipenv`.
 
@@ -85,7 +86,7 @@ This should install all the libraries required for testing & running repo2docker
 
 - Using `pipenv`
 
-Note that you will need to install pipenv first using `pip3 install pipenv`. 
+Note that you will need to install pipenv first using `pip3 install pipenv`.
 Then from the root directory of this project you can use the following commands:
 
 ```bash
@@ -94,7 +95,7 @@ pipenv install --dev
 
 This should install both the dev and docs requirements at once!
 
-### Set up 
+### Set up
 
 ### Verify that docker is installed and running
 
@@ -129,7 +130,3 @@ Server:
 ```
 
 Then you are good to go!
-
-
-
-