Open MPI logo

Network Locality Devel Mailing List Archives

  |   Home   |   Support   |   FAQ   |   all Network Locality Devel mailing list

Subject: Re: [netloc-devel] Documentation
From: BRADLEY, PETER C PW (peter.c.bradley_at_[hidden])
Date: 2013-12-05 11:15:56

I'm just getting started with it and agree some docs would be helpful. Looks promising, although I've had to do some hotwiring to make it work on our cluster, and I got a few broken links in the graph. When I get a few minutes to get back to it, I'll write up what I found.


-----Original Message-----
From: netloc-devel [mailto:netloc-devel-bounces_at_[hidden]] On Behalf Of Jeff Squyres (jsquyres)
Sent: Thursday, December 05, 2013 11:07 AM
To: <netloc-devel_at_[hidden]>
Subject: [External] [netloc-devel] Documentation

One issue that came up at SC is that we're currently pretty light on documentation.

One thing I can do is do hwloc-style Doxygen web pages integrated into the web site. That will get at least some level of coverage on the API side of things.

We can also do web-ified man pages for the CLI side of things, if that would be useful.

Does anyone have a few cycles to write up a FAQ, perchance? And/or record simple screencasts showing how to setup and run some of the CLI commands? (doesn't have to be anything fancy -- just 2-3 minutes showing short, simple actions -- I have video editing stuff, so I can add subtitles or do some editing if it would be helpful)

Jeff Squyres
For corporate legal information go to:
netloc-devel mailing list