Adjust the minute and install plugin documentation

teemtee · Sep 15, 2020 · 7548040 · 7548040
1 parent d79a4f1
commit 7548040
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 15 deletions.
diff --git a/spec/steps/prepare.fmf b/spec/steps/prepare.fmf
@@ -56,19 +56,20 @@ description: |
 /install:
  summary:
  Install packages on the guest
- description:
+ description: |
  One or more RPM packages can be specified under the
  ``package`` attribute. The packages will be installed
  on the guest. They can either be specified using their
- names or paths to local .rpm files.
+ names or paths to local rpm files.
 
- Additionaly, ``directory`` attribute can be used to install
- all packages from the given directory. Copr repositories
- can be enabled using the ``copr`` attribute. It's possible
- to change the behaviour when a package is missing using the
- ``missing`` attribute. The missing packages can either be
- silently ignored ('skip') or a preparation error is thrown
- ('fail'), which is the default behaviour.
+ Additionaly, the ``directory`` attribute can be used to
+ install all packages from the given directory. Copr
+ repositories can be enabled using the ``copr`` attribute.
+ It's possible to change the behaviour when a package is
+ missing using the ``missing`` attribute. The missing
+ packages can either be silently ignored ('skip') or a
+ preparation error is thrown ('fail'), which is the default
+ behaviour.
 
  example: |
  prepare:

diff --git a/spec/steps/provision.fmf b/spec/steps/provision.fmf
@@ -99,14 +99,16 @@ example: |
  key: private-key-path
 
 /minute:
- summary: Provision a virtual machine using 1minutetip OpenStack backend
+ summary:
+ Provision a virtual machine using the 1minutetip OpenStack
+ backend
  description: |
- First check whether a prereserved machine exists
- using the 1minutetip backend. Use it, if it exists, otherwise
- boot a new machine using the OpenStack backend.
+ First check whether a prereserved machine exists using the
+ 1minutetip backend. Use it, if it exists, otherwise boot a
+ new machine using the OpenStack backend.
 
- Note that you need to have the 1minutetip script installed in
- order for this provision method to work.
+ Note that you need to have the ``1minutetip`` script
+ installed in order for this provision method to work.
  example: |
  provision:
  how: minute