ADR 11: Content directory

Context

Content of the course is mixed with various configuration files, scripts and python virtualenv directory. This complicates identification of needed files by authors. It also requires to specify all files that should be processed in configuration, because not all files in the root directory should be processed.

Decision

We decided to store all content in a special directory – content. No files outside of this directory would be copied to the output directory.

In the model of the course, all paths are stored relative to the content directory.

Status

Accepted.

Consequences

This solution brings some symmetry into the files — input files in the content directory and output files in the output directory. Everything else is just configuration.

This setup also makes it possible to copy all files and directories from the content directory to the output without special specification of patterns for copied files.