#152 Verify Documentation and User-Friendly Defaults for libtaskotron
Closed: Fixed None Opened 9 years ago by tflink.

One of our higher priorities for libtaskotron is to ensure that the local usage experience is as pain-free as we can reasonably make it.

Start with a system that does not have libtaskotron installed.
Install libtaskotron locally according to our documentation
execute several example tasks, following documentation where appropriate

Note any areas which are not documented or confusing. Verify that log locations are predictable and that the default configuration is optimized for local stand-alone installations.


This ticket had assigned some Differential requests:
D174

How to install taskotron, run it and how to write tasks is well documented, anyway in D174 I created quick start proposal. When starting with some new library or tool, I always welcome such pages. Detailed information that docs provides is often drowned in surrounding text. Quick start provides better overall demonstration, I know how is the lib/tool used and I can read details later. For those familiar with libtaskotron, quick start could be used as cheat sheet.

D174 has landed. I have one more question/proposal.

Quick start is now accessible only through docs and on [[ https://taskotron-stg.fedoraproject.org/ | taskotron stg ]] there is menu (with Home, Wiki, Issue Tracker and Documentation), can we add link to quick start into that menu?

Metadata Update from @tflink:
- Issue tagged with: easyfix

6 years ago

Login to comment on this ticket.

Metadata