+1 I like these ideas.
One thing I would add.
If we do have a wiki and sphinx in source control then we should have one
place where users can search through *both* places.
That way they don't have to look through one and then look through the other
to find answers.
Paul
On Fri, Feb 27, 2009 at 11:06 AM, Yarko Tymciurak <yark...@gmail.com>wrote:
> I haven't fully thought about this yet, but in general -
> Wiki == freeform idea collection; I agree that some structure to begin and
> guide is good;
>
> Good place for transient information;
>
> I would think once content is in a sphinx doc (and I agree completely w/
> source control - much like what the Python 3 Patterns book is following) it
> should be pulled form the wiki (maybe a final revision referring to the
> "published" page, and then new updates maintained in sphinx doc).
>
> This will prevent the considerable problem of diverging documentation ("I
> documented it here; Oh! Look - there's something similar, but a little
> different here - which is right? which is current?")
>
> Perhaps a feedback look from sphinx would be useful (we organized best w/
> these sections, so we now re-organize the wiki to - at least at a high level
> - match).
>
> Anyway, I have an idea, I don't know where to put it, I want to share it
> --- this is definitely wiki space, and others can add / update....
>
>
> Just rambling thoughts during lunch...
>
> Yarko
>
> On Fri, Feb 27, 2009 at 9:27 AM, cjparsons <cjparso...@yahoo.co.uk> wrote:
>
>>
>> > Use the wiki for the initial gathering of doc pages, then after the
>> > first sphinx-based documentation is produced, just clean the wiki of
>> > those pages. After that, just use the wiki for contributed recipes
>> > and other pages, some of which are selectively migrated to sphinx.
>> > Keep the changes due to new releases in sphinx only.
>> >
>> > Just asking.
>> +1. Once the accepted documentation is there I think we need to keep
>> the wiki to recipies so as not to confuse new users as to where to
>> look for the greatest information. I know I found having the draft
>> manual, alter ego, cookbook, source code etc. to look at for answers
>> quite confusing (though more is better than less, obviously).
>>
>>
>
> >
>
--
Best Regards,
Paul Eden
"...and a little looking out for the other guy too."
- Mr. Smith
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"web2py Web Framework" group.
To post to this group, send email to web2py@googlegroups.com
To unsubscribe from this group, send email to
web2py+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/web2py?hl=en
-~----------~----~----~----~------~----~------~--~---
