Update README.md (s)

README.md

@@ -5,5 +5,8 @@
 [ets-wfs20-dockerfile](ets-wfs20-dockerfile) | Execute ets-wfs suite tests for WFS.
 [ets-cat30-dockerfile](ets-cat30-dockerfile) | Execute ets-csw suite tests for CSW.
 [jsonschema2md](jsonschema2md) | Generate `.md` files based on `.json` schema.
-[swagger-codegen-2.2.3](swagger-codegen/2.2.3) | Generate code from API description file in swagger format. Documentation [here](swagger-codegen/2.2.3/README.md).
-[swagger-codegen-2.3.1](swagger-codegen/2.3.1) | Generate code from API description file in swagger format. Documentation [here](swagger-codegen/2.3.1/README.md).
+[typedoc-dockerfile](typedoc-dockerfile) | Generate `.md` files from annotated typescipt files. Generated files have the host user UID & GID. Documentation [here](typedoc-dockerfile/README.md).
+[swagger-codegen-2.2.3](swagger-codegen/2.2.3) | Generate code from API description file in swagger format, with UID/GID management. Documentation [here](swagger-codegen/2.2.3/README.md).
+[swagger-codegen-2.3.1](swagger-codegen/2.3.1) | Generate code from API description file in swagger format, with UID/GID management. Documentation [here](swagger-codegen/2.3.1/README.md).
+[maven-3.5-jdk8-alpine](maven-3.5-jdk8-alpine) | Apply `mvn` phases (`clean`, `install`, ...) on your maven project,with UID/GID management. Documentation [here](maven-3.5-jdk8-alpine/README.md).
+[python-3-alpine](python-3-alpine) | Run `python` command on `file.py`, with UID/GID management. Documentation [here](python-3-alpine/README.md).

typedoc-dockerfile/README.md

@@ -1,36 +1,52 @@
-## Usage : 
+[TypeDoc](https://typedoc.org/) docker image, able to generate documentation, in markdown, from annotated typescript files. Generated files have the host user group ID and the user ID.
 
-- Place your terminal in the folder where your tagged typescript files reside : your project folder.
-- Every non-native typescript module should be declared in a `package.json` file that is to be placed in the project folder.
-- Mount the project folder as a volume into /docs :
+The docker image is named `gisaia/typedocgen`
 
-```
-docker run --rm -it -v `pwd`:/docs gisaia/typedocgen:0.0.5 generatedoc
-```
+---
 
->Most of the time, your project folder contains a node_modules folder that can be source of troubles while generating the documentation.
-Please consider in that case applying the following use case:
+- [Build](#build)
+- [Publication](#publication)
+- [Usage](#usage)
+  * [Example](#example)
 
+<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>
 
-- If you want to generate documentation from typscript files that are in a specific folder in your project folder :
+# Build
 
 ```
-docker run --rm -it -v `pwd`:/docs gisaia/typedocgen:0.0.5 generatedoc relative/path/to/the/specific/folder
+docker build -t gisaia/typedocgen:x.x.x gisaia/typedocgen:latest .
 ```
 
-## Generated documentation :
-
-The markdown files are generated in `typedoc_docs` folder within your project folder.
+# Publication
 
-## Publish the docker image in DockerHub : 
-
-```
-docker build -t gisaia/typedocgen:x.x.x gisaia/typedocgen:latest .
-```
-```
-docker login
-```
 ```
 docker push gisaia/typedocgen:x.x.x
 docker push gisaia/typedocgen:latest
-```
+```
+
+# Usage
+
+- Place your terminal in the folder where your tagged typescript files reside : your project folder.
+- Every non-native typescript module should be declared in a `package.json` file that is to be placed in the project folder.
+- The image is to be used with the `docker run` command. Various `docker run` parameters can be used:
+
+| Parameter | Type | Description |
+-|-|-
+`--mount dst=/docs,src=...,type=bind,ro` | File bind-mount | Bind-mounts the typescript files from the host machine, whose path is indicated by the `src=...` parameter.
+`generatedoc` | Documentation generation command| Generates the md files with the group ID and the user ID of the host machine.
+| | Command line arguments | You can generate documentation from typscript files that are in a specific folder in your mounted project, just by appending it at the end of the `docker run` command (after the name of the image). Example: `specific/folder` |
+
+> Note : The markdown files are generated in `typedoc_docs` folder within your project folder.
+
+## Example
+
+```bash
+
+# - Run generatedoc command`
+docker run \
+  --mount dst=/docs,src="$PWD/project",type=bind \
+  --rm \
+  gisaia/swagger-codegen-2.2.3 \
+    generatedoc \
+    relative/path/to/folder
+```