Skip to content

Commit

Permalink
Describe features covered by the minimal package (#3472)
Browse files Browse the repository at this point in the history
* Describe features covered by the minimal package

Let's be a bit more specific about the features which are covered
by the minimal ``tmt`` package.

* Update the `minimal` install description, mention in the guide

* Mention that `ansible` is a weak dependency
  • Loading branch information
psss authored Jan 28, 2025
1 parent 40591e1 commit 973a35e
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ The First Steps
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Installing the main package with the core functionality is quite
straightforward. No worry, there are just a few dependencies:
straightforward. No worry, the :ref:`/stories/install/minimal`
package has just a few dependencies:

.. code-block:: shell
Expand Down Expand Up @@ -85,8 +86,8 @@ dependencies here:
tmt run -a provision -h virtual
Don't care about the disk space? Simply install ``tmt+all`` and
you'll get all available functionality at hand. Check the help to
list all supported provision methods:
you'll get :ref:`/stories/install/all` available functionality at
hand. Check the help to list all supported provision methods:

.. code-block:: shell
Expand Down
23 changes: 23 additions & 0 deletions stories/install.fmf
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,29 @@ link:

/minimal:
summary: Minimal tmt installation with core features only
description: |
The minimal package provides basic functionality which
covers mainly these areas:

* explore and lint existing tests, plans and stories
* create new tests, plans and stories from templates
* execute tests on the :ref:`/plugins/provision/local`
host or :ref:`/plugins/provision/connect` to a remote
guest using ssh
* prepare guest using the
:ref:`/plugins/prepare/ansible`,
:ref:`/plugins/prepare/feature`,
:ref:`/plugins/prepare/install` and
:ref:`/plugins/prepare/shell` plugins
* report test results to :ref:`/plugins/report/display`
or into an :ref:`/plugins/report/html` page

.. note::

If you are used to install packages without optional
dependencies, ansible features might not be working as
they are a weak dependency of the minimal package.

example: dnf install tmt
link+:
- verified-by: /plans/install/minimal
Expand Down

0 comments on commit 973a35e

Please sign in to comment.