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.

Sign up for GitHub

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

Jump to bottom

Python client documentation #671

Open
19 of 56 tasks
PeterGottesman opened this issue Jul 11, 2018 · 5 comments
Open
19 of 56 tasks

Python client documentation #671

PeterGottesman opened this issue Jul 11, 2018 · 5 comments
Assignees
@DebRez @PeterGottesman
Labels
enhancement Python Client

Comments

@PeterGottesman
Copy link
Contributor

PeterGottesman commented Jul 11, 2018 •
edited by DebRez

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.

  • Plugins
    • Location they are loaded from
    • Directory structure
    • Architecture - i.e. how to make your own
    • Naming scheme
  • Functionality of existing plugins - options need to be documented
    • JunitXML
    • IUDatabase
    • TextFile
    • FooFlash
    • DefaultProfile
    • DefaultMTTDefaults
    • WWulf3
    • DefaultTestBuild
    • ModuleCmd
    • Copytree
    • Watchdog
    • Environ
    • ExecuteCmd
    • Logger
    • MPIVersion
    • Compilers
    • MTTVersion
    • IPMITool
    • ALPS
    • SLURM
    • OpenMPI
    • Hostfile
    • Autotools
    • Shell
    • Harasser
    • Git
    • 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 PeterGottesman self-assigned this Jul 11, 2018
@PeterGottesman
Copy link
Contributor Author

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

@PeterGottesman PeterGottesman changed the title Python client in desperate need of documentation Python client documentation Jul 11, 2018
@rhc54
Copy link
Contributor

rhc54 commented Jul 11, 2018

@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
Copy link
Contributor Author

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

@Jagaskak
Copy link
Contributor

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

@PeterGottesman PeterGottesman mentioned this issue Aug 10, 2018
Merged
@DebRez DebRez self-assigned this Feb 27, 2019
@DebRez
Copy link
Contributor

DebRez commented Feb 27, 2019

I will be working on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DebRez DebRez

@PeterGottesman PeterGottesman

Labels
enhancement Python Client
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@rhc54 @DebRez @PeterGottesman @Jagaskak