Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation and changing website layout #688

Merged
merged 1 commit into from
Aug 14, 2018

Conversation

Jagaskak
Copy link
Contributor

Signed-off-by: Akshaya Jagannadharao [email protected]

Website I'm trying to build should look like this one: https://jagaskak.github.io/mtt/

Lots of changes (I captured the more important ones here):

  • Changed layout of website so it's easier to navigate
  • Deleted duplicate _config.yml since it exists in the docs directory.
  • Updated Doxygen so that every plugin has short description of what it does
  • Created pages folder for documentation
  • Added placeholder files for documentation that is currently being created but will take some more time to review/add to
  • Plugin and INI documentation created
  • Updated pictures that were in the wiki

Things to look for:

  • Information that is for the Perl Client only
  • Out of date/inaccurate information
  • Things that require better clarity
  • Anything is helpful

- Sets the configuration for tests
- Logs results
- Loads plugins by called LoadClasses
- Starts execution of tests by called one of the [Executor](https://github.com/open-mpi/mtt/tree/master/pylib/Tools/Executor) plugins. The [combinatorial](https://github.com/open-mpi/mtt/blob/master/pylib/Tools/Executor/combinatorial.py) plugin is currently the default plugin; however, the [sequential](https://github.com/open-mpi/mtt/blob/master/pylib/Tools/Executor/sequential.py) plugin can be set by using the ```--executor=sequential``` flag.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default executor is sequential:

mtt/pyclient/pymtt.py

Lines 273 to 277 in 75cd103

# Cli specified executor takes precedent over INI
# If there is nothing defined in either use fallback
fallback = "sequential"
executor = args.executor or testDef.config.get('MTTDefaults', 'executor', fallback=fallback)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok! Fixed it. Thanks for pointing that out.

@Jagaskak Jagaskak force-pushed the topic/add_docs_to_website branch from e55a3c3 to c163eaf Compare August 10, 2018 14:22
docs/README.md Outdated
It should be noted that the software has been mostly developed internally
to the Open MPI project and will likely experience some growing pains
while adjusting to a larger community.
MTT is divided into multiple phases of execution to split up grabbing content, building content, running content, and reporting results (please refer to the [INI documentation](/mtt/docs/ini_docs.html) to learn more).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

INI documentation URL should be /mtt/pages/ini_docs.html

@Jagaskak Jagaskak force-pushed the topic/add_docs_to_website branch from c163eaf to 2f4842f Compare August 10, 2018 19:20
@PeterGottesman
Copy link
Contributor

Akshaya, this looks really good. I haven't had much time to look over it, but what I have seen so far is good. I will try to look over/fact check over the weekend, but it is likely good to merge.

refs #671

@rhc54 rhc54 merged commit aab6136 into open-mpi:master Aug 14, 2018
emallove pushed a commit to emallove/mtt that referenced this pull request Dec 7, 2019
Adding documentation and changing website layout
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants