El vie, 21-04-2006 a las 16:03 -0400, Peter Beckman escribi?:
> I've documented in the "Function Reference" section a few AGI and a few > Dialplan functions. Not deeply, but enough to give a decent idea of what I > hope this project could become. > > Comment away! > > http://mph.gotdns.com:82/manual/en/index.php I like the framework (I can't wait to see the /manual/eS/ page ;) Thanks!
I hope that using this framework making a Spanish translation shouldn't be extremely difficult.
> There is something strange in the include files that causes my server to > not load superfast... I'm tracking that down. It's something copied from > PHP.net that's doing it. How can we start making the contributions?
I fixed the strange issue with the docs mentioned above.
Right now the docs sit on my home server. I think Jared was going to set
up an SVN area I could put the code in and allow people to check it out
and contribute.
There are a few things that I believe need to happen though:
1. Asterisk Docs member buy-in. I'm not familiar with who
heads/runs/manages the AsteriskDocs.org project and website. I
don't want to step on toes pushing a new way to document onto a
bunch of people who have clearly put in many hours of work into this
project already. If the Ast-doc folk like what they see, great.
I'd love to see everyone on the team get excited about this and
throw their support behind it.
2. Document the process. We could just put this in SVN and see what
happens, but just letting everyone go to town making documentation
is an easy way for things to get messy very quickly. There needs to
be a process to allow people be commiters, a review process for each
commit, some guidelines that documentation writers need to
follow, and an automated way to enforce as many of those guidelines
as possible, to reduce the amount of effort "supermods" need to put
forth to get good documentation to the people.
3. Commitment to constant review. Documentation is only as good as its
editors. If the docs contain inaccurate, misspelled and just plain
wrong information, then all that work will be in vein. People need
to commit to reviewing documentation bug submissions and making
updates quickly and accurately. A small team needs to interface
constantly with the development team to make sure that documentation
for 1.2.8 is ready and available when the dev team releases 1.2.8,
not 2 months later.
We can take a lot of these things from the PHP Documentation Group. They
have guidelines, scripts, and have documented fairly well the process to
documentation. By riding on the coattails of their successful framework,
the Asterisk Documentation can continue to grow and flourish as Asterisk
matures even futher.
I am but one person; for this to work there needs to be a small and
dedicated group of people willing to back eachother up, help enforce some
guidelines and rules, and keep things moving. I'm in, but I can't do it
alone.
Beckman
---------------------------------------------------------------------------
Peter Beckman Internet Guy
[EMAIL PROTECTED] http://www.purplecow.com/
---------------------------------------------------------------------------El vie, 21-04-2006 a las 16:03 -0400, Peter Beckman escribió: > I'm pleased to announce that I've got it working! Great! > I've documented in the "Function Reference" section a few AGI and a few > Dialplan functions. Not deeply, but enough to give a decent idea of what I > hope this project could become. > > Comment away! > > http://mph.gotdns.com:82/manual/en/index.php > I like the framework (I can't wait to see the /manual/eS/ page ;) Thanks! > There is something strange in the include files that causes my server to > not load superfast... I'm tracking that down. It's something copied from > PHP.net that's doing it. How can we start making the contributions? > > > Beckman > > On Fri, 21 Apr 2006, Andrew Latham wrote: > > > Maybe we should start with the applications, pick one and write up > some info on it and examples. > > eg... http://www.php.net/manual/en/function.array.php > > On 4/21/06, Jim Van Meggelen <[EMAIL PROTECTED]> wrote: > > > > > -----Original Message----- > > > From: Leif Madsen [mailto:[EMAIL PROTECTED] > > > Sent: April 21, 2006 8:33 AM > > > To: Discussions regarding The Asterisk Documentation Project > > > Subject: Re: [Asterisk-doc] Is the project dead? > > > > > > On 4/21/06, Steve Kennedy <[EMAIL PROTECTED]> wrote: > > > > > On thing that is certain is that the docs project could use some > > > > > fresh ideas, so we would encourage anyone who has a desire to > > > > > contribute to get involved. > > > > > > > > If I can help in some way, let me know. > > > > > > > > Unfortunately without decent documentation Asterisk will > > > always be a > > > > "techie toy", and I don't mean any disrespect when saying > > > that to all > > > > the hard works that's been done. > > > > > > I'm looking forward to seeing the PHP-style documentation > > > project that is being started by Peter Beckman -- I think > > > once a framework is up and running, we focus our time and > > > efforts on that because then you can just pick a section and > > > work on it without being really dedicated to writing a whole > > > chapter like in our previous efforts with the Volumes. > > > > > > I believe it'll make the whole documentation process a lot > > > more sane and manageable -- but only time will tell I suppose. > > > > One thing I would caution against is making this turn into too much of a > > Wiki. Not because wikis are bad--to the contrary, we already have an > > excellent wiki, and do not want to compete with it. What we had originally > > envisioned was a volume of books on various topics, from installation to > > low-level debugging. Which books got written would be determined by what > > talent we could attract, and we would offer editorial assistance as part of > > the project (one of the challenges of the wiki is that it is so chock-full > > of knowledge it's hard to know what is relevant or current). For the docs > > project, we thought it would be good to be more focused--to complement the > > wiki. > > > > Jim > > > > -- > > Jim Van Meggelen > > [EMAIL PROTECTED] > > http://www.oreillynet.com/pub/au/2177 > > > > "A child is the ultimate startup, and I have three. > > This makes me rich." > > Guy Kawasaki > > -- > > > > -- > > No virus found in this outgoing message. > > Checked by AVG Free Edition. > > Version: 7.1.385 / Virus Database: 268.4.4/320 - Release Date: 20/04/2006 > > > > > > _______________________________________________ > > --Bandwidth and Colocation provided by Easynews.com -- > > > > Asterisk-Doc mailing list > > To UNSUBSCRIBE or update options visit: > > http://lists.digium.com/mailman/listinfo/asterisk-doc > > > > > -- > --- > Andrew Latham - AKA: LATHAMA (lay-th-ham-eh) > [EMAIL PROTECTED] - [EMAIL PROTECTED] - [EMAIL PROTECTED] > If any of the above are down we have bigger problems than my email! > Hind sight is most always 20/20 or better. > --- > > --------------------------------------------------------------------------- > Peter Beckman Internet Guy > [EMAIL PROTECTED] http://www.purplecow.com/ > --------------------------------------------------------------------------- > _______________________________________________ --Bandwidth and Colocation > provided by Easynews.com -- Asterisk-Doc mailing list To UNSUBSCRIBE or > update options visit: http://lists.digium.com/mailman/listinfo/asterisk-doc > _______________________________________________ --Bandwidth and Colocation > provided by Easynews.com -- Asterisk-Doc mailing list To UNSUBSCRIBE or > update options visit: http://lists.digium.com/mailman/listinfo/asterisk-doc -- Alejandro Ríos Peña Subgerente Comercial Avatar Ltda. Bogotá D.C. (+57) 300 390 4764
signature.asc
Description: Esta parte del mensaje está firmada digitalmente
_______________________________________________ --Bandwidth and Colocation provided by Easynews.com -- Asterisk-Doc mailing list To UNSUBSCRIBE or update options visit: http://lists.digium.com/mailman/listinfo/asterisk-doc
_______________________________________________ --Bandwidth and Colocation provided by Easynews.com -- Asterisk-Doc mailing list To UNSUBSCRIBE or update options visit: http://lists.digium.com/mailman/listinfo/asterisk-doc
