qpid-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Marnie McCormack <marnie.mccorm...@googlemail.com>
Subject Re: Qpid docs - file structure and organization
Date Thu, 15 Apr 2010 14:03:44 GMT
Hi,

Apologies if I missed anything ....

I've made a few updates to the wiki over the last few weeks. I'm assuming
the docbook import will be refreshed before replacing the existing wiki
content ?
Marnie
On Thu, Apr 15, 2010 at 2:34 PM, Jonathan Robie
<jonathan.robie@redhat.com>wrote:

>  On 04/15/2010 09:16 AM, Alan Conway wrote:
>
>> On 04/14/2010 01:14 PM, Jonathan Robie wrote:
>>
>>> On 04/14/2010 10:24 AM, Rajith Attapattu wrote:
>>>
>>>> As I have mentioned in the past, we should just publish what we have
>>>> right now.
>>>> If we wait until it's perfect this will never be done.
>>>> I am not worried about dangling links. We could resolve them in time.
>>>>
>>>> What we have now can't be any worse than the current wiki docs.
>>>> **So please lets publish what we have now.**
>>>> Once it's more visible more people will participate.
>>>>
>>>
>>> I agree - what we have is no worse than the current Wiki, and getting
>>> this posted would put pressure on us all to actually use it.
>>>
>>> I think a few days would be enough to get rid of a few embarrassing
>>> things - I can do that next week but not this week, I'm slammed. I
>>> suggest the following:
>>>
>>> 1. Next week, put the svn content up alongside the current Wiki, on the
>>> home page, with a notice that the Wiki is being phased out as primary
>>> documentation.
>>>
>>> 2. Make all changes to the svn documentation moving forward (it's OK to
>>> make it to the Wiki too)
>>>
>>> 3. Plan to convert completely to the svn documentation in some
>>> reasonable timeframe (to be defined). Drop the Wiki as soon as we're
>>> convinced the svn DocBook is good enough to do so.
>>>
>>> How does this sound?
>>>
>>>
>> Sounds good to me, but I just want to clarify: We're not talking about
>> replacing the entire wiki with docbook, only the documentation pages. The
>> project related stuff (getting started, where to download etc.) stays on the
>> wiki. Right?
>>
>
> Current system:
>
> * Everything is a Wiki
>
> Proposed system:
>
> * Rajith's static HTML pages for initial landing page, project info
> * DocBook in svn for documentation
> * Wiki plays a much less prominent role
>
> I think the goal is to put project-related stuff on static HTML pages -
> things like "Getting Started" and "Where to Download", as well as guidance
> for new contributers, etc. would live there.
>
>
> I suggest we be aggressive about getting docbook on line and deleting the
>> redundant wiki content as soon as we can. If the docbook needs polish,
>> better to do that after we've switched than to prolong the confusing
>> docbook/wiki redundancy.
>>
>
> OK. Makes sense. We'll put this up next week, alongside the Wiki, and start
> deleting redundant Wiki content.
>
> Jonathan
>
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project:      http://qpid.apache.org
> Use/Interact: mailto:dev-subscribe@qpid.apache.org
>
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message