Documentation

As a command line user I want to have all essential documentation at hand.

examples

As a new user I would like to experiment with the tool.

A couple of instructive examples should be included in the package for easy first experimenting. Examples should be stored under the /usr/share/doc directory.

Examples:

cd /usr/share/doc/tmt/examples
ls
cd mini
tmt test ls
tmt plan ls
tmt run

Status: implemented and verified

guide

As a user migrating from old tools I want to quickly learn how to achieve my common daily tasks with the new tooling.

Note

This is a draft, the story is not implemented yet.

Provide a Quick Start Guide describing the most common scenarios and showing mapping of old command to the new syntax.

Examples:

How do I do '1minutetip fedora' with tmt?

How do I do 'wow --reserve' with tmt?

How do I do 'make run' with tmt?

Status: idea

help

As a command line user I want to quickly check all available options and supported commands.

All available options should be easily discoverable directly from the command line using the --help option.

Examples:

tmt --help

tmt run --help

tmt test import --help

Status: implemented and verified

man

As a command line user I want to check the man page to get a basic overview about the tool.

There should be a manual page availabe in the package. Man page should contain brief introduction about the tool and a list of essential commands and options.

Examples:

man tmt

Status: implemented and verified