Hi Marnie,
I think ./devel always refers to whatever matches what the most recent
docs in svn, ./stable always refers to the latest released docs (which
will have even numbers), and we only create ./0.6, ./0.8, etc. when we
do a release. So you're right, we won't see odd version numbers here.
Does that make sense?
Jonathan
On 04/23/2010 11:28 AM, Marnie McCormack wrote:
Hi Jonathan,
I missed the debate about versions, but we'll only ref 0.6 then 0.8 in doc
is that right ? So if we're working on something with a 0.7 version on trunk
when its released the docs should ref 0.8 but the devel links will go to 0.7
docs ?
Sorry if I have the stick by the wrong end (not that the numbers are
confusing :-)
I think whats you're proposing makes sense, though I'm not sure how best to
ref back and forward as we make changes but using absolute refs avoids
confusion or inadvertant links to non-relevant pages.
Thanks,
Marnie
On Fri, Apr 23, 2010 at 4:20 PM, Jonathan Robie
<[email protected]>wrote:
I'm getting ready to post the DocBook docs on the Qpid web site along with
API docs (looks like early next week at this point).
I want to make sure we have a good plan to handle versions and links among
documents. I think a file structure like this might work well:
Versions
http://qpid.apache.org/doc/
contains all docs
http://qpid.apache.org/devel/
symlink to the devel version of the documentation
http://qpid.apache.org/stable/
symlink to the docs for the latest release
http://qpid.apache.org/doc/ 0.6/
docs for a specific version
Subdirectories
http://qpid.apache.org/doc/stable/book/
Current Wiki, converted to book. We may eventually subdivide this into
different guides, e.g. http://qpid.apache.org/doc/stable/book/programming,
or http://qpid.apache.org/doc/stable/book/broker-java.
http://qpid.apache.org/doc/stable/api/cpp
C++ API reference, generated by Doxygen
http://qpid.apache.org/doc/stable/api/cpp
Python API reference, generated by ePydoc
Links among Documents
Links should be absolute links to the current version of the documentation.
For instance, a link from
http://qpid.apache.org/doc/0.6/book/qpid-book.html to the C++ API docs
should point to http://qpid.apache.org/doc/0.6/api/cpp
Tracking changes in the text
We should endeaver to use phrases like "since 0.6" to identify new features
and changes, so the latest documentation shows what has changed.
Does this makes sense? Once we start using a given structure, it becomes
harder to change, so I want to get agreement on this up front.
Jonathan
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:[email protected]
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:[email protected]
