Re: [Phpgroupware-developers] Re: Standard source code header and php Documentor

[Dave Hall]

Brian Johnson <address@hidden> wrote:

> what are we talking about here?
> 1. docs for developers hosted on a centralized server
> 2. docs for developers installed with phpgw on the developer's own 
> server
> 3. docs for users hosted on a centralized server
> 4. docs for users installed with phpgw on the user's own server
> 
> IMO we need (1 OR 2) AND (3 OR 4)
> 
> A group writable/editable system (with user permissions) and a 
> world readable system
> is prefered
> 
> A centralized server is best IMO since changes can immediately be 
> seen by users.
> Then the manual app in phpgw can maybe just link to the 
> appropriate wiki page on
> phpgroupware.org
> 
> For user docs, wouldn't a suitably arranged section of the wiki be 
> suitable?
> For developer docs, could a readonly section be made on the wiki 
> that IS the inline
> docs (perhaps with html pages updated nightly by cron) and another 
> section that is
> editable by the appropriate group?
> 
> I like my docs in one place and an organized wiki could be a 
> wonderful thing
> 
> 
> PS the docs in general DO badly need editing/creation but I'm not 
> a big fan of
> inline docs.  Others must agree or they wouldn't have systems to 
> extract them to
> other formats

I like this idea.  The default version IMHO 1 and 3, with nightly cron
builds for 2 and 4.

Anyone want to code/port something to acheive this?

> 
> 
> address@hidden wrote:
> >
> >My thoughts on this discussion: Kai proposes do do some work that has
> >not been done, and seems to be a very valuable contribution, so I 
> feel>very unconfortable if the first answer he gets is of an agressive
> >style. It is true that moving from one documentation style to another
> >needs discussion, and Kai should have asked for this discussion,
> >before heading in one direction.
> >But as I see it, we have the alternative between our current
> >documentation style, which is used only partially by us, and not
> >common among other projects, and a proposal to implement 
> completely -
> >even if it takes some time - a new style that seems a sort of 
> standard>for many PHP projects. This proposal seems reasonable to me.
> >
> >Michael
> >
> >"Chris Weiss" <address@hidden> a écrit:
> >
> >>>So whats the problem? Maybe your statement on wiki isn't complete?
> >>
> >> from outside (since I'm not "core" and don't have API access 
> myself), it seems the
> >> problem is that everything you submit is followed up by am out 
> of sorts discusion.
> >>
> >> Also keep in mind that some of us have been here for years and 
> still don't have API
> >> commit access, and probably never will.  Unless you're actually 
> maintaining code for
> >> the api there's no need, docs are not code, neither are lang 
> files, and neither
> >> require much maintainance.  Both are very needed but neither 
> warrent api commit
> access.
> >
> >
> >
> >_______________________________________________
> >Phpgroupware-developers mailing list
> >address@hidden
> >http://mail.gnu.org/mailman/listinfo/phpgroupware-developers
> >
> 
> --
> Brian Johnson
> * This is where my witty signature line would be if I bothered to 
> edit this line :) *
> 
> 
> 
> 
> _______________________________________________
> Phpgroupware-developers mailing list
> address@hidden
> http://mail.gnu.org/mailman/listinfo/phpgroupware-developers
>

dave.hall.vcf
Description: Card for <dave.hall@mbox.com.au>