Checked in the current draft of the new guide

[Juan Manuel Palacios]

	Thanks for the great documentation progress guys!

	I cleaned up some of our documentation tickets up on trac:

*) renamed the "doc" component to "guide"
*) relocated most of the old doc component tickets I could find to  
more appropriate components, of course leaving there the ones that  
belong.

	What I intended with these changes is the following: we now have a  
documentation milestone and two documentation related components,  
"base" and "guide", the former for stuff like our man pages (and  
maybe doxygen like in source documentation in the future) and the  
latter being self explanatory; any new documentation related tickets  
should be filed under the appropriate milestone and its component  
flagged accordingly. I believe this split gives us nicely, fine- 
grained enough (but not too much) organizational choices. Please feel  
free to suggest something different if you believe this will not  
suite us (but if you do, you're gonna have to help me through trac  
adapting tickets as needed! :-P)

	So, moving forward, I skimmed over the new guide sources and filed  
my first ticket:

http://trac.macports.org/projects/macports/ticket/12284

	Guide Masters, start your engines!

	Once the new guide properly replaces the old one we're gonna have to  
think about removing the latter and adapting the Makefile targets and  
GuideRegen.sh script to build the new one. Mark, how are you  
currently building the new guide? Any automation put into that?  
(hint: base/portmgr/GuideRegen.sh)

	I'm hoping you guys can give us a heads-up when you believe we're  
ready to flip the coin and make this change (I'm figuring at that  
point the trunk/doc/guide/xml/newguide.xml file will have to be  
renamed to something more appropriate).

	Regards,...


-jmpp


PS: I made markd at macports.org default owner for tickets under the  
"guide" component. Please advice if you'd like to have that changed  
to something else, but trac allows only a single owner per component  
and no other way of informing there's more than one in charge for a  
particular one, like Maun Suang and Mark for this case, as I had in  
mind.


On Jul 13, 2007, at 8:20 AM, Anders F Björklund wrote:

> Mark wrote:
>
>>> 	More over, we can all agree to nominate Maun Suang and you "Guide
>>> Masters": rather than simply diving in and committing patches to the
>>> sources in svn, we instead upload them to tickets in the
>>> "Documentation" milestone and you guys, governing that milestone,
>>> review them and decide when/how to commit them, rewriting them if
>>> need be.
>>
>> Sounds like a decent plan to me.  I just committed what I have so  
>> far.
>>
>> xml/newguide.xml
>> http://trac.macosforge.org/projects/macports/browser/trunk/doc/ 
>> guide/xml/newguide.xml?rev=26949
>>
>> resources/newdocbook.css
>> http://trac.macosforge.org/projects/macports/browser/trunk/doc/ 
>> guide/resources/newdocbook.css?rev=26950
>>
>> Hack away!  Needs work in the reference sections, among others.  
>> 6.2 and
>> 6.3 have placeholders for keywords and Tcl primitives  
>> respectively.  Full
>> comments in the svn checkout logs.
>
> I committed a new target ("make new") to the guide Makefile, so  
> that one
> can generate the "new" html (it uses the docbook XSL and generates  
> XHTML)
>
> Also added the missing copyright information, which unfortunately was
> left out of your "Minimalist Guide". It also needs a documentation  
> license
> added later, so that the guide can be distributed along with the  
> software.
> Probably some Open Content license, to match the Open Source BSD  
> license ?
>
> Will leave the rest of the updates to you guys, and use the Trac  
> Tickets.
>
>> See the the updated copy with a slightly different stylesheet at  
>> my .mac
>> page for those wanting a peek at the draft of the new guide.   
>> Colors are
>> awful!  You have been warned!
>
> It just uses the DarwinPorts color scheme still, so it's a bit too  
> "cute"...
> http://web.archive.org/web/20070103015001/http:// 
> darwinports.opendarwin.org/
> Probably it can be redone along with the main MacPorts website  
> <hint hint>.
> As in: better to do a proper redesign of the entire MacPorts  
> "brand" later ?
>
> Hopefully there are lots of web designers wanting to help the  
> project ? :-)
>
> --anders
>
> _______________________________________________
> macports-dev mailing list
> macports-dev at lists.macosforge.org
> http://lists.macosforge.org/mailman/listinfo/macports-dev