docs: richer user guide

reanahub / reana-workflow-engine-serial

REANA Workflow Engine Serial

http://reana-workflow-engine-serial.readthedocs.org

MIT License

0 stars 33 forks source link

docs: richer user guide #40

Closed tiborsimko closed 6 years ago

tiborsimko commented 6 years ago

Introduce usual Getting started, User guide, Developer guide page structure. See other modules.

Describe in the user guide the caching feature. How to turn it off or on via reana-client. Warn users in case of environment docker images changes or in case the workflow contains random generators.

Decide about the best default, caching on or off. Former is nice but may be aggressive. Latter is safer but less nice.

Investigate whether CACHING=0/1 may be used instead of CACHING=true/false.

tiborsimko commented 6 years ago

... and can also include a separate v0.3.1 release commit afterwards.

diegodelemos commented 6 years ago

Closed by https://github.com/reanahub/reana-workflow-engine-serial/pull/41 and https://github.com/reanahub/reana-client/pull/167.