Commit 38df5104 authored by Merlijn Wajer's avatar Merlijn Wajer
Browse files

doc: minor improvements

parent ba9d9289
......@@ -14,7 +14,7 @@ You have landed on the documentation for the Internet Archive's
so called "deriver modules" in Python. Deriver modules are pieces of code that
operate on uploaded files, creating "derivative" formats (for example, if one
uploads a ``flac`` audio file, a derivative ``opus`` file could be created to
allow for quicker downloads of a lossy various of the audio.
allow for quicker downloads of a lossy variant of the audio.
Concept: the container environment
......@@ -30,14 +30,14 @@ The contain environment has the following paths and files set up::
<other item files>
task.json (task arguments, source/target files)
petabox.json (petabox config)
/tmp (disk backed)
/var/tmp/fast (ram backed tmpfs)
TODO: General description of various files in docker derive process, what
metadata is stored where, etc.
The ``Dockerfile`` defines the starting point of the container (``CMD``), and if
a non-zero exit code is returned, the derive task fails.
......@@ -49,6 +49,8 @@ Overview of keys:
* ``sourceFormat``: format of source file (``str``)
* ``targetFile``: absolute path to the target file for the derive (``str``)
* ``targetFormat``: format of the target file (``str``)
* ``task``: dictionary with task information, containing at least ``args`` as a
key to access task arguments.
* ``?``
......@@ -146,6 +148,9 @@ From the root directory of your project, run these steps:
.. TODO: Add some remarks on clear error messages, ones that can be matched for
red for classification, etc
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment