qpid-users mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Alan Conway <acon...@redhat.com>
Subject [dispatch] new documentation, website updated.
Date Wed, 21 Jan 2015 17:19:04 GMT
The qpid site has been updated for the dispatch 0.3 release. All the
documentation is now on the site so easier to access:      
    <http://qpid.apache.org/releases/qpid-dispatch-0.3/index.html>

We are severely under-documented. Please report any mistakes or gaps
(with your idea of how to fix them if possible!) to this list, in a JIRA
or, if you are a committer, *Just Fix It*. 

Updating the docs is easy, we use
[markdown](http://daringfireball.net/projects/markdown/syntax)  which
takes 5 mins to learn and requires nothing but a text editor. See
docs/README for the layout of the doc source.

If you add or modify features PLEASE update the docs accordingly.
Features that nobody knows how to use are really just dead code. If you
don't write docs you will end up answering the same questions about your
feature over and over again, so it will save you time in the long run. 

Documentation is generated and installed by make. If the doc generation
is annoying you do:
    cmake -DBUILD_DOCS=OFF

Cheers,
Alan.


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@qpid.apache.org
For additional commands, e-mail: users-help@qpid.apache.org


Mime
View raw message