Python client documentation

[PeterGottesman]

There is a lot of documentation that is needed for the python client, I seem to be searching through the code to find what I need most of the time. I'm adding stuff off the top of my head as I think of it, so feel free to add to the list as you see fit.

• [x] Plugins
  • [x] Location they are loaded from
  • [x] Directory structure
  • [x] Architecture - i.e. how to make your own
  • [x] Naming scheme
• [ ] Functionality of existing plugins - options need to be documented
  • [ ] JunitXML
  • [ ] IUDatabase
  • [ ] TextFile
  • [ ] FooFlash
  • [ ] DefaultProfile
  • [x] DefaultMTTDefaults
  • [x] WWulf3
  • [ ] DefaultTestBuild
  • [ ] ModuleCmd
  • [x] Copytree
  • [x] Watchdog
  • [ ] Environ
  • [ ] ExecuteCmd
  • [ ] Logger
  • [ ] MPIVersion
  • [ ] Compilers
  • [ ] MTTVersion
  • [x] IPMITool
  • [x] ALPS
  • [x] SLURM
  • [x] OpenMPI
  • [x] Hostfile
  • [x] Autotools
  • [x] Shell
  • [x] Harasser
  • [x] Git
  • [x] AlreadyInstalled
  • [ ] combinatorial
  • [ ] sequential
• [ ] Plugin parent classes - Most of these just need a line or two
  • [ ] ReporterMTTStage
  • [ ] LauncherDefaultsMTTStage
  • [ ] FirmwareMTTStage
  • [ ] ProfileMTTStage
  • [ ] MTTDefaultsMTTStage
  • [ ] TestGetMTTStage
  • [ ] MiddlewareGetMTTStage
  • [ ] MiddlewareBuildMTTStage
  • [ ] ProvisionMTTStage
  • [ ] TestBuildMTTStage
  • [ ] TestRunMTTStage
  • [ ] BIOSMTTStage
  • [ ] BaseMTTUtility
  • [ ] VersionMTTTool
  • [ ] CNCMTTTool
  • [ ] LauncherMTTTool
  • [ ] BuildMTTTool
  • [ ] HarasserMTTTool
  • [ ] FetchMTTTool
  • [ ] ExecutorMTTTool

Maybe this would fit well in @jagaskak's github pages?

That is really, really long. Sorry about that, but I think it is important to have a checklist somewhere with the documentation that is needed.

[PeterGottesman]

I assigned myself, but there is not a lot I have a full picture of yet. Any other help with this would be very greatly appreciated

[rhc54]

@PeterGottesman We are trying to get the documentation onto the MTT web site. @jagaskak hasn't succeeded in getting Travis properly plumbed yet. Meantime, you can see the docs here:

https://jagaskak.github.io/mtt/html/index.html

[PeterGottesman]

Thanks Ralph! I checked off everything that is already documented and will be sure to keep up with any changes to the docs.

[Jagaskak]

Finally got the website running for MTT's repo: https://open-mpi.github.io/mtt/

[DebRez]

I will be working on this.