Use "repository" instead of "repo" consistently.

pull/381/head
Evert Rol 2018-08-20 13:04:01 +02:00
rodzic 58945128c4
commit 0d78f48909
7 zmienionych plików z 19 dodań i 19 usunięć

Wyświetl plik

@ -33,7 +33,7 @@ make that your current directory with `cd repo2docker`.
### Set up a local virtual environment
After cloning the repository (or your fork of the repo), you should set up an
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. There are many ways to do this, and a `virtual environment` is
one of them.
@ -102,7 +102,7 @@ py.test -s tests/<path-to-test>
## Update and Freeze BuildPack Dependencies
### Updating libraries installed for all repos
### Updating libraries installed for all repositories
For both the `conda` and `virtualenv` (`pip`) base environments in the **Conda BuildPack** and **Python BuildPack**,
we install specific pinned versions of all dependencies. We explicitly list the dependencies

Wyświetl plik

@ -4,7 +4,7 @@
[![Documentation Status](https://readthedocs.org/projects/repo2docker/badge/?version=latest)](http://repo2docker.readthedocs.io/en/latest/?badge=latest)
**jupyter-repo2docker** takes as input a repository source, such as a GitHub
repo. It then builds, runs, and/or pushes Docker images built from that source.
repository. It then builds, runs, and/or pushes Docker images built from that source.
See the [repo2docker documentation](http://repo2docker.readthedocs.io)
for more information.
@ -35,8 +35,8 @@ pip install -e .
## Usage
The core feature of repo2docker is to fetch a repo (from github or locally),
build a container image based on the specifications found in the repo &
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.
**Note that Docker needs to be running on your machine for this to work.**

Wyświetl plik

@ -24,7 +24,7 @@ If the folder ``binder/`` is located at the top level of the repository,
The `binder examples <https://github.com/binder-examples>`_ organization on
GitHub contains a list of sample repositories for common configurations
that ``repo2docker`` can build with various configuration files such as
Python and R installation in a repo.
Python and R installation in a repository.
Below is a list of supported configuration files (roughly in the order of build priority):

Wyświetl plik

@ -103,7 +103,7 @@ Step 5. Push Away, Merrill!
Once the environment variables are set up, you can push or issue a pull request
to see circle build the workflow. Remember that you only need the ``.circleci/config.yml``
and not any other files in the repository. If your notebook is hosted in the same repo,
and not any other files in the repository. If your notebook is hosted in the same repository,
you might want to add these, along with your requirements.txt, etc.
.. tip::

Wyświetl plik

@ -5,7 +5,7 @@ and have found an answer, send a PR to add it here!
## How should I specify another version of Python 3?
One can specify a Python version in the ``environment.yml`` file of a repo.
One can specify a Python version in the ``environment.yml`` file of a repository.
## Can I add executable files to the user's PATH?

Wyświetl plik

@ -2,11 +2,11 @@ jupyter-repo2docker
===================
**jupyter-repo2docker** is a tool to build, run, and push Docker
images from source code repositories. repo2docker fetches a repo
(e.g., from GitHub or other locations) and builds a container image based
on the configuration files found in the repo. It can be used to explore a
repository locally by building and executing the constructed image of the
repository.
images from source code repositories. repo2docker fetches a repository
(e.g., from GitHub or other locations) and builds a container image
based on the configuration files found in the repository. It can be
used to explore a repository locally by building and executing the
constructed image of the repository.
Please report `Bugs <https://github.com/jupyter/repo2docker/issues>`_,
`ask questions <https://gitter.im/jupyterhub/binder>`_ or

Wyświetl plik

@ -10,15 +10,15 @@ order to run ``repo2docker``. For more information on installing
``repo2docker`` performs two steps:
1. builds a Docker image from a git repo
2. runs a Jupyter server within the image to explore the 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
repo2docker is called with this command::
jupyter-repo2docker <URL-or-path to repo>
jupyter-repo2docker <URL-or-path to repository>
where ``<URL-or-path to repo>`` is a URL or path to the source repository.
where ``<URL-or-path to repository>`` is a URL or path to the source repository.
For example, use the following to build an image of Peter Norvig's
Pytudes_::
@ -38,14 +38,14 @@ specify the ``branch-name`` or ``commit-hash``::
Building the image may take a few minutes.
During building, ``repo2docker``
clones the repository to obtain its contents and inspects the repo for
clones the repository to obtain its contents and inspects the repository for
:ref:`configuration files <config-files>`.
By default, ``repo2docker`` will assume you are using
Python 3.6 unless you include the version of Python in your
:ref:`configuration files <config-files>`. ``repo2docker`` support is best with
Python 2.7, 3.5, and 3.6. In the case of this repo, a Python version is not
specified in their configuation files and Python 3.6 is installed.
Python 2.7, 3.5, and 3.6. In the case of this repository, a Python version is not
specified in their configuration files and Python 3.6 is installed.
Pytudes_
uses a `requirements.txt file <https://github.com/norvig/pytudes/blob/master/requirements.txt>`_