Quantcast

RFC: Documentation

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

RFC: Documentation

weierophinney
Administrator
Per our IRC meeting last week, Rob, Gary, myself, and Enrico have
created an RFC:

    http://framework.zend.com/wiki/display/ZFDEV2/RFC+-+Documentation

Please review, and let us know if you have any additions/changes/qualms
about it.

--
Matthew Weier O'Phinney
Project Lead            | [hidden email]
Zend Framework          | http://framework.zend.com/
PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

Re: RFC: Documentation

Artur Bodera
On Wed, Jun 27, 2012 at 9:09 PM, Matthew Weier O'Phinney <[hidden email]> wrote:
Per our IRC meeting last week, Rob, Gary, myself, and Enrico have
created an RFC:

   http://framework.zend.com/wiki/display/ZFDEV2/RFC+-+Documentation

Please review, and let us know if you have any additions/changes/qualms
about it.



 Can we get it going ? :-)

Great timing. I'd love not to be forced to learn the old, xml format. I can do markdown-style
poetry though. 

-- 
      __
     /.)\   +48 695 600 936
     \(./   [hidden email]




 
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

Re: RFC: Documentation

weierophinney
Administrator
-- Artur Bodera <[hidden email]> wrote
(on Saturday, 30 June 2012, 11:48 PM +0200):

> On Wed, Jun 27, 2012 at 9:09 PM, Matthew Weier O'Phinney <[hidden email]>
> wrote:
>
>     Per our IRC meeting last week, Rob, Gary, myself, and Enrico have
>     created an RFC:
>
>        http://framework.zend.com/wiki/display/ZFDEV2/RFC+-+Documentation
>
>     Please review, and let us know if you have any additions/changes/qualms
>     about it.
>
>  Can we get it going ? :-)
>
> Great timing. I'd love not to be forced to learn the old, xml format.
> I can do markdown-style poetry though.

For components and features finishing in time for beta5, we'll still
need to do docbook. However, the thrust immediately following beta5 will
be to do repository cleanup (moving service components out of the main
repo, moving docs to a separate repo, etc.), and migrating
documentation. Enrico has already started working with the
ZetaComponents Document component to work out a migration script, and
once we have it in reasonable shape, we'll switch to reST for
documentation for the RCs and stable version.

I, too, look forward to simpler markup -- while I appreciate the power
of DocBook, it's _so_ hard to remember all the tags, and I find all the
nested indentation cumbersome. I can write wiki formats, Markdown, and
reST in my sleep. :)

--
Matthew Weier O'Phinney
Project Lead            | [hidden email]
Zend Framework          | http://framework.zend.com/
PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
Loading...