Glossary¶
- Docker¶
"Docker provides a way to run applications securely isolated in a container, packaged with all its dependencies and libraries."
Installation: Get Docker from https://docs.docker.com/install/
- DRC¶
- Docutils¶
See http://docutils.sourceforge.net/rst.html and chapter About Docutils: The basics of ReST.
reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for standalone documents…
- dockrun¶
Docker commands can be very long and complicated. To make things easier we sometimes use helper scripts like "t3rd" (T3 render documentation. We allways prefix those names with
dockrun_
to make explicite what the scripts are doing in the end. There may bedockrun_XXX.bat
for Windows anddockrun_XXX.sh
- or so - for other systems.- jobfile¶
This is usually a JSON file named
jobfile.json
. The idea is to make all possible settings and options configurable in that one single file. It can have any name. That file is in the hands of the system administrator or operator.- OS¶
Operating system, such as Windows, Linux or macOS.
- RenderDocumentation¶
This is the specific toolchain that we are using.
- reST¶
reStructuredText is the markup language used.
- reST files¶
reST files are plain utf-8 text files, that optionally have markup that can be parsed and understood as reStructuredText.
- TCT¶
This is the toolchain runner that we are using. The original name was "tool chain tool", hence the abbreviation TCT.
- toolchain¶
This is the name of a folder that resides in the Toolchains_Starting folder. The toolchain is an arbitrary structure of files and subfolders holding executables that have a name starting with
run_
.