Thanks for your "RFC on FAQs"!
There go my two cents:
A) Keep the FAQ, please!
I am a big fan of the OpenMPI FAQ.
I use them all the time.
I also recommend them to everybody on this list and on other lists.
I've seen a lot of people do the same.
In the absence of more comprehensive documentation,
the FAQ is the resource we all count on to fix mistakes,
look for a forgotten syntax, setup our computers to work properly
with OpenMPI, learn a new concept, etc.
So, whatever you do, please don't do away with the FAQs,
unless you already have more comprehensive documentation
ready to replace the FAQ.
B) Add an "ALL FAQ" category, to make keyword search easier
on web browsers.
Keyword search of the FAQ is a bit cumbersome when one
has 26 different FAQ categories / web pages to search for.
A very simple / minimal effort way to allow web search
of the whole FAQ set would be to add the "ALL FAQ"
category to the current FAQ categories list (maybe on the very top
of the list).
The "ALL FAQ" page would concatenate all of your FAQ HTML files,
allowing keyword search across all FAQs in any web browser.
One doesn't need to be fancy and stylish to be effective.
C) Please write the (long overdue) FAQ set about the
I asked before, and I beg for it again:
Please write a set of FAQs about
OpenMPI collectives, and how to tune them up.
The current resource available to learn about collectives
are several sparse postings on the mailing list archive.
Despite the interesting questions posed and the generous answers
provided about collectives on the mailing list,
they don't form a coherent elucidating body,
and are not easy to follow.
Some questions about collectives that in one way
or another have been asked on the list:
Which algorithms are available for each collective?
What is the rationale behind these algorithms?
What is the default algorithm used by each collective?
How do you enforce the use of a certain collective algorithm?
What are the pros and cons of hardwiring
a choice of collective algorithm?
How to tune up the collective algorithms to your application and to
And more ...
Lamont-Doherty Earth Observatory - Columbia University
Palisades, NY, 10964-8000 - USA
Jeff Squyres wrote:
> I have some simple questions for all you users out there about the OMPI FAQ. I ask because we see a LOT of you end up on the OMPI FAQ in our web statistics (most users who search either end up on the FAQ and/or on the web archives of the mailing list). Hence, I'd like to know if we can improve the FAQ from a usability standpoint.
> 1. Is the FAQ useful in its current form? More specifically:
> - I personally find it a little difficult to web search for something and then end up on a single FAQ page with a LOT of information on it (e.g., the text for all the questions/answers in that category). I.e., if I'm searching for something specific, it would be useful to end up on a page with *just that one FAQ question/answer*.
> - OTOH, if I don't know exactly what I'm looking for, it is useful to see a whole page of FAQ questions and answers so that I can scan through them all to find what I'm looking for (vs. clicking through a million different individual pages).
> 2. We wrote all the PHP for the OMPI FAQ ourselves (it's not driven by a database; the content is all in individual text files). Back when we started, we surveyed the web FAQ systems and found each of them lacking for one reason or another (I don't remember the details), and therefore wrote our own PHP stuff. Do people have other FAQ web systems that they'd recommend these days?
> 3. Are there other features from an FAQ that you would like to see in the OMPI FAQ?
> I ask these questions because a) the current system has annoyed me a few too many times recently for various limitations, and b) I'm wondering if there is something better out there -- better searching, more web-2.0-ish, ...whatever. We're certainly not tied to the existing FAQ system -- the current set of questions and answers is fairly easy to extract from the PHP, so we could move it to another system if it would be desirable.