Skip to content

Commit b20438b

Browse files
committed
specification info
1 parent e976627 commit b20438b

File tree

3 files changed

+23
-1
lines changed

3 files changed

+23
-1
lines changed

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Please report `Bugs <https://github.com/jupyter/repo2docker/issues>`_,
4242
:caption: Complete list of configuration files
4343

4444
config_files
45+
specification
4546

4647
.. toctree::
4748
:maxdepth: 2

docs/source/specification.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. _specification:
2+
3+
====================================================
4+
The Reproducible Execution Environment Specification
5+
====================================================
6+
7+
repo2docker scans a repository for particular :ref:`config_files`, such
8+
as ``requirements.txt`` or ``REQUIRE``. The collection of files and their contents
9+
that repo2docker uses is known as the **Reproducible Execution Environment Specification**.
10+
11+
The goal of the REE Specification is to provide a structure that is clearly-defined and that
12+
can be extended to accomodate more components of a reproducible workflow.
13+
14+
Currently, the definition of the REE Specification is the following:
15+
16+
> Any collection of files taken from the :ref:`config_files`
17+
> list, placed either in the root of a folder or in a sub-folder called either ``binder/`` or ``.binder/``.
18+
19+
In the future, the repo2docker team plans to formalize this specification into a pattern
20+
that can also be followed in other ways, such as by creating a JSON or YAML file.

docs/source/usage.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ Using ``repo2docker``
1010
order to run ``repo2docker``. For more information on installing
1111
``repo2docker``, see :ref:`install`.
1212

13-
``repo2docker`` is called with a URL/path to a git repository. It then
13+
``repo2docker`` can build a reproducible computational environment for any repository that
14+
follows :ref:`specification`. repo2docker is called with a URL/path to a git repository. It then
1415
performs these steps:
1516

1617
1. Inspects the repository for :ref:`configuration files <config-files>`. These will be used to build

0 commit comments

Comments
 (0)