modularity-testing-framework

#71 MTF docs revision version 0.1
Merged by phracek. Opened by igulina.
igulina/modularity-testing-framework master  into  master

Download 71.patch

This PR is opened for REVIEW and FEEDBACK purposes only, and can't be merged. The PR's author needs to know if the proposed doc draft is a fair replacement of the current documentation structure. Also please comment lines which contains any kind of error or smth is not clear. Even if evrth is ok, the changed doc pages contain links to the other doc pages and source code files, which have not been updated yet or don't exist, and therefore it can't be merged.

The PR html build is available in RH network: http://10.43.2.197/~igulina/mod/build/html/index.html
Original docs: http://modularity-testing-framework.readthedocs.io/en/latest/

PR content:
- README contains only what MTF is and a link to the full documentation
- Revised content structure:
About: What MTF is and what it can
Installation: Vagrant and local installation, Source code and contribution notes
User Guide: Steps on how to write tests, creation of module's conf file, notes about environment variables, troubleshooting, introduced glossary page
License: a link to the LICENSE file in MTF source code repository
Index: alphabetic list of library classes, methods and functions
Search Page

The tool is not only for Fedora modules, but also for containers. I would not mention any link. Or link like https://docs.pagure.org/modularity/

The same here. Please use link https://docs.pagure.org/modularity/ which is used for both, as modules as containers.

Please add there also link to https://github.com/container-images named _Fedora containers.

I would prefer to have link to pydoc generated API also in top menu. because when you are writing tests you are looking for this, so it should be easily accessible

And also good to mention that it also allow to be used for general purpose tests (with internal multi host support)
It was developed for modules, but actually it is not focused just for modules, and could be used for writing general tests for components too.
Multihost support is also important to mention there.

@jscotka, Can you please verify this. Is it correct?

Perfect work @igulina, I'm glad that you've improved that

generator should be used only in case, that test's are specified in config.yaml file.

This should be moved to the root menu so user is able to find an API quickly.

rebased

The PR html build is available in RH network: http://10.43.2.197/~igulina/mod/build/html/index.html

Unfortunately, this doesn't help contributors... Could you put it on fedorapeople please?

s/aid/help/

this looks like real command which should be ran from root user..

@ignatenkobrain, what is wrong with 'aid'. See
[1] http://dictionary.cambridge.org/dictionary/english/aid
[2] http://www.dictionary.com/browse/aid

@ignatenkobrain, this is a comment, the real command executed via sudo on the next line

@phracek, did I understand correct that wording:
Line ``generator`` is optional and needed only if you have multi like Bash snippet tests.
should be replaced with
Mind to include line 'generator' only if there are multiline Bash tests in the config,yaml file?

@phracek, is it ok, if I rewrite it as "a tool to test a modulat Fedora" and a link to https://docs.pagure.org/modularity/ ?

@phracek, is it ok, if I rewrite it as "a tool to test a modulat Fedora" and a link to https://docs.pagure.org/modularity/ ?

1 new commit added

  • docs typos, errors and whitespaces

1 new commit added

  • Ops

6 new commits added

  • docs typos, errors and whitespaces
  • docs introducing glossary page
  • docs list of test methods
  • docs user guide main steps, conf file,env variables, troubleshooting
  • docs intro page, license, installation
  • Simple README with what MTF is and a link to docs

1 new commit added

  • docs following PR review remarks

Pull-Request has been merged by phracek
Metadata
None
No Tags
Static archive. pagure.io was sunset in 2026; this is a read-only snapshot.
Red Hat Logo

Fedora is sponsored by Red Hat. Learn more about the relationship between Red Hat and Fedora »

© Red Hat, Inc. and others.