Posted: Thu Apr 20, 2006 11:10 pm Post subject: [Asterisk-doc] Is the project dead?
Hello all.
I bought the O'Reilly book and think is great, but I still would like to
see a more open-source asterisk documentation effort, like the old
"Volume One", so it can be community-grown. Is the asteriskdocs.org
project dead?
I also would like to know if the spanish-translation project of
asteriskdocs.org (https://ourproject.org/projects/asterix/) is still
alive or not, so I could help somehow.
Regards.
--
Alejandro Ríos Peña
Ing. en Electrónica y Telecomunicaciones.
Avatar ltda.
Grupo GNU/Linux Universidad del Cauca - GLUC.
Comunidad Debian-Colombia.
_______________________________________________
--Bandwidth and Colocation provided by Easynews.com --
Posted: Thu Apr 20, 2006 11:41 pm Post subject: [Asterisk-doc] Is the project dead?
I wouldn't call it dead, just busy. Most of the developers are adding
features faster than they can be noted by others. http://voip-info.org
keeps up to date.
My suggestions would be to do a help from the CLI and translate that,
submit it to the list, that would be a start.
On 4/20/06, Alejandro RÃos P. <alejandro.rios@avatar.com.co> wrote:
Quote:
Hello all.
I bought the O'Reilly book and think is great, but I still would like to
see a more open-source asterisk documentation effort, like the old
"Volume One", so it can be community-grown. Is the asteriskdocs.org
project dead?
I also would like to know if the spanish-translation project of
asteriskdocs.org (https://ourproject.org/projects/asterix/) is still
alive or not, so I could help somehow.
Regards.
--
Alejandro RÃos Peña
Ing. en Electrónica y Telecomunicaciones.
Avatar ltda.
Grupo GNU/Linux Universidad del Cauca - GLUC.
Comunidad Debian-Colombia.
--
---
Andrew Latham - AKA: LATHAMA (lay-th-ham-eh)
lathama@lathama.com - lathama@yahoo.com - lathama@gmail.com
If any of the above are down we have bigger problems than my email!
Hind sight is most always 20/20 or better.
---
_______________________________________________
--Bandwidth and Colocation provided by Easynews.com --
Posted: Fri Apr 21, 2006 1:03 am Post subject: [Asterisk-doc] Is the project dead?
Alejandro,
We are not at all dead, but Asteriskdocs is certainly not being nourished as
it deserves. Leif, Jared and I have gotten so busy over the last little
while that we are having a very tough time making contributions.
We are dreaming of a new group of folks that can help, because we are
finding that we cannot handle the work that the docs project deserves.
As for the any translations, I have to admit that I do not know how they are
going.
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.
"A child is the ultimate startup, and I have three.
This makes me rich."
Guy Kawasaki
--
Quote:
-----Original Message-----
From: Alejandro Ríos P. [mailto:alejandro.rios@avatar.com.co]
Sent: April 20, 2006 7:15 PM
To: asterisk-doc@lists.digium.com
Cc: leonardo@hipatia.info
Subject: [Asterisk-doc] Is the project dead?
Hello all.
I bought the O'Reilly book and think is great, but I still
would like to see a more open-source asterisk documentation
effort, like the old "Volume One", so it can be
community-grown. Is the asteriskdocs.org project dead?
I also would like to know if the spanish-translation project
of asteriskdocs.org
(https://ourproject.org/projects/asterix/) is still alive or
not, so I could help somehow.
Regards.
--
Alejandro Ríos Peña
Ing. en Electrónica y Telecomunicaciones.
Avatar ltda.
Grupo GNU/Linux Universidad del Cauca - GLUC.
Comunidad Debian-Colombia.
--
No virus found in this incoming message.
Checked by AVG Free Edition.
Version: 7.1.385 / Virus Database: 268.4.4/319 - Release
Date: 19/04/2006
--
No virus found in this outgoing message.
Checked by AVG Free Edition.
Version: 7.1.385 / Virus Database: 268.4.4/319 - Release Date: 19/04/2006
_______________________________________________
--Bandwidth and Colocation provided by Easynews.com --
Posted: Fri Apr 21, 2006 1:58 am Post subject: [Asterisk-doc] Is the project dead?
El jue, 20-04-2006 a las 21:08 -0400, Jim Van Meggelen escribió:
Quote:
Alejandro,
We are not at all dead, but Asteriskdocs is certainly not being nourished as
it deserves. Leif, Jared and I have gotten so busy over the last little
while that we are having a very tough time making contributions.
We are dreaming of a new group of folks that can help, because we are
finding that we cannot handle the work that the docs project deserves.
As for the any translations, I have to admit that I do not know how they are
going.
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.
OK, count me in then. I'll take a little time to carefully examine the
current status of the cvs contents and voip-info.org and then make some
initial planning.
Lets do some more brainstorming on this so we make sure to get in the
right way.
"A child is the ultimate startup, and I have three.
This makes me rich."
Guy Kawasaki
--
> -----Original Message-----
> From: Alejandro Ríos P. [mailto:alejandro.rios@avatar.com.co]
> Sent: April 20, 2006 7:15 PM
> To: asterisk-doc@lists.digium.com
> Cc: leonardo@hipatia.info
> Subject: [Asterisk-doc] Is the project dead?
>
> Hello all.
>
> I bought the O'Reilly book and think is great, but I still
> would like to see a more open-source asterisk documentation
> effort, like the old "Volume One", so it can be
> community-grown. Is the asteriskdocs.org project dead?
>
> I also would like to know if the spanish-translation project
> of asteriskdocs.org
> (https://ourproject.org/projects/asterix/) is still alive or
> not, so I could help somehow.
>
> Regards.
>
> --
> Alejandro Ríos Peña
> Ing. en Electrónica y Telecomunicaciones.
> Avatar ltda.
> Grupo GNU/Linux Universidad del Cauca - GLUC.
> Comunidad Debian-Colombia.
>
> --
> No virus found in this incoming message.
> Checked by AVG Free Edition.
> Version: 7.1.385 / Virus Database: 268.4.4/319 - Release
> Date: 19/04/2006
>
>
>
Posted: Fri Apr 21, 2006 2:16 am Post subject: [Asterisk-doc] Is the project dead?
Quote:
OK, count me in then. I'll take a little time to carefully examine the
current status of the cvs contents and voip-info.org and then make some
initial planning.
I'm working on a PHP-like documentation for Asterisk. See
http://php.net/manual/en/ -- I hope to have something done by early next
week. It will document all the config files, functions, AGI,
installation, etc. I won't have all the documentation done, but I will
have the Framework in DocBook format.
From there documentation can be generated into an online format, a print
format, even into PDF. The way PHP set it up it can also be easily
translated.
Contact me offline and we'll see if we can coordinate efforts.
Beckman
---------------------------------------------------------------------------
Peter Beckman Internet Guy
beckman@purplecow.comhttp://www.purplecow.com/
---------------------------------------------------------------------------
_______________________________________________
--Bandwidth and Colocation provided by Easynews.com --
Posted: Fri Apr 21, 2006 3:51 am Post subject: [Asterisk-doc] Is the project dead?
El jue, 20-04-2006 a las 22:16 -0400, Peter Beckman escribió:
Quote:
> OK, count me in then. I'll take a little time to carefully examine the
> current status of the cvs contents and voip-info.org and then make some
> initial planning.
I'm working on a PHP-like documentation for Asterisk. See
http://php.net/manual/en/ -- I hope to have something done by early next
week. It will document all the config files, functions, AGI,
installation, etc. I won't have all the documentation done, but I will
have the Framework in DocBook format.
From there documentation can be generated into an online format, a print
format, even into PDF. The way PHP set it up it can also be easily
translated.
Contact me offline and we'll see if we can coordinate efforts.
Yes, I saw the related thread on the mailing list archives. I hope we
can see what you've got soon ;)
Quote:
Beckman
---------------------------------------------------------------------------
Peter Beckman Internet Guy
beckman@purplecow.comhttp://www.purplecow.com/
---------------------------------------------------------------------------
--
Posted: Fri Apr 21, 2006 7:50 am Post subject: [Asterisk-doc] Is the project dead?
On Thu, Apr 20, 2006 at 09:08:06PM -0400, Jim Van Meggelen wrote:
Quote:
We are not at all dead, but Asteriskdocs is certainly not being nourished as
it deserves. Leif, Jared and I have gotten so busy over the last little
while that we are having a very tough time making contributions.
We are dreaming of a new group of folks that can help, because we are
finding that we cannot handle the work that the docs project deserves.
As for the any translations, I have to admit that I do not know how they are
going.
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.
Steve
--
NetTek Ltd UK mob +44-(0)7775 755503
UK +44-(0)20 79932612 / US +1-(310)8577715 / Fax +44-(0)20 7483 2455
Skype/GoogleTalk/AIM/Gizmo stevekennedyuk / MSN steve@gbnet.net
Euro Tech News Blog http://eurotechnews.blogspot.com
_______________________________________________
--Bandwidth and Colocation provided by Easynews.com --
Posted: Fri Apr 21, 2006 12:27 pm Post subject: [Asterisk-doc] Is the project dead?
On 4/21/06, Steve Kennedy <steve-asterisk@gbnet.net> wrote:
Quote:
> 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.
Leif Madsen.
_______________________________________________
--Bandwidth and Colocation provided by Easynews.com --
Posted: Fri Apr 21, 2006 3:40 pm Post subject: [Asterisk-doc] Is the project dead?
Quote:
-----Original Message-----
From: Leif Madsen [mailto:asterisk.leif.madsen@gmail.com]
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 <steve-asterisk@gbnet.net> 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.
On 4/21/06, Jim Van Meggelen <jim@vanmeggelen.ca> wrote:
Quote:
> -----Original Message-----
> From: Leif Madsen [mailto:asterisk.leif.madsen@gmail.com]
> 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 <steve-asterisk@gbnet.net> 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.
--
---
Andrew Latham - AKA: LATHAMA (lay-th-ham-eh)
lathama@lathama.com - lathama@yahoo.com - lathama@gmail.com
If any of the above are down we have bigger problems than my email!
Hind sight is most always 20/20 or better.
---
_______________________________________________
--Bandwidth and Colocation provided by Easynews.com --
Posted: Fri Apr 21, 2006 8:00 pm Post subject: [Asterisk-doc] Is the project dead?
I'm pleased to announce that I've got it working!
There is MUCH work to be done to get it to the right place for public
consumption, but I've got a good start on it.
Much of the documentation is copied from PHP, and I'm sure there is a lot
of documentation in there that needs to be deleted, updated, etc. But the
framework is there.
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.
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.
Beckman
On Fri, 21 Apr 2006, Andrew Latham wrote:
Quote:
Maybe we should start with the applications, pick one and write up
some info on it and examples.
On 4/21/06, Jim Van Meggelen <jim@vanmeggelen.ca> wrote:
Quote:
> -----Original Message-----
> From: Leif Madsen [mailto:asterisk.leif.madsen@gmail.com]
> 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 <steve-asterisk@gbnet.net> 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.
--
---
Andrew Latham - AKA: LATHAMA (lay-th-ham-eh)
lathama@lathama.com - lathama@yahoo.com - lathama@gmail.com
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
beckman@purplecow.comhttp://www.purplecow.com/
---------------------------------------------------------------------------
_______________________________________________
--Bandwidth and Colocation provided by Easynews.com --
Posted: Sat Apr 22, 2006 10:23 pm Post subject: [Asterisk-doc] Is the project dead?
El vie, 21-04-2006 a las 16:03 -0400, Peter Beckman escribió:
Quote:
I'm pleased to announce that I've got it working!
Great!
Quote:
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.
I like the framework (I can't wait to see the /manual/eS/ page ;)
Thanks!
Quote:
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?
Quote:
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.
On 4/21/06, Jim Van Meggelen <jim@vanmeggelen.ca> wrote:
>
> > -----Original Message-----
> > From: Leif Madsen [mailto:asterisk.leif.madsen@gmail.com]
> > 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 <steve-asterisk@gbnet.net> 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
> jim@vanmeggelen.ca
> 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)
lathama@lathama.com - lathama@yahoo.com - lathama@gmail.com
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
beckman@purplecow.comhttp://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
--
Posted: Sun Apr 23, 2006 11:09 pm Post subject: [Asterisk-doc] Is the project dead?
El vie, 21-04-2006 a las 16:03 -0400, Peter Beckman escribió:
Quote:
> 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.
Quote:
> 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
beckman@purplecow.comhttp://www.purplecow.com/
---------------------------------------------------------------------------
El vie, 21-04-2006 a las 16:03 -0400, Peter Beckman escribió:
Quote:
I'm pleased to announce that I've got it working!
Great!
Quote:
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.
I like the framework (I can't wait to see the /manual/eS/ page ;)
Thanks!
Quote:
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?
Quote:
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.
On 4/21/06, Jim Van Meggelen <jim@vanmeggelen.ca> wrote:
>
> > -----Original Message-----
> > From: Leif Madsen [mailto:asterisk.leif.madsen@gmail.com]
> > 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 <steve-asterisk@gbnet.net> 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
> jim@vanmeggelen.ca
> 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)
lathama@lathama.com - lathama@yahoo.com - lathama@gmail.com
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
beckman@purplecow.comhttp://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
--
Posted: Sun Apr 30, 2006 10:15 pm Post subject: [Asterisk-doc] Is the project dead?
On 4/23/06, Peter Beckman <beckman@purplecow.com> wrote:
Quote:
> 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.
I guess technically that would be Jared Smith, Jim van Meggelen and
myself. I'm excited, but the reason for the lack of documentation
lately is that we're all extremely busy and haven't had any "new
blood" in quite some time. While Asterisk is growing in terms of the
number of people using it, I have yet to see any significant number of
people able and willing to contribute documentation -- its been this
way for over 2 years unfortunately.
Quote:
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.
I'd rather keep the number of people who have access to the SVN
repository to a small and controlled group or else we're going to have
all sorts of problems. Documentation needs some very special attention
such as editing and verification (as much as is practical).
The #asterisk-doc channel on IRC is a really good place to discuss
things -- I don't get a chance to look at the mailing list every
single day, but I'm usually on IRC for good portions of the day -- at
least checking in and bugging Jared with my questions :)
Quote:
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.
Very difficult to do -- when we were writing the starfish book, we
were trying to keep up with the developers in order to try and be as
accurate as possible when 1.2 was finally released -- let me tell you,
that was QUITE some work, and many pages (and even a chapter) needed
to be totally re-written. However, saying that, with the new release
cycle, it should be a lot easier to keep up to date, and not so many
fundamental changes are going to happen between releases -- such as
they did between 1.0 and 1.2.
Quote:
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.
This is what I'm hoping to -- however, I'm not in the position to take
on yet another project. I'd like to be more of someone to look to for
guidance as I've been playing this game for quite a while now, but
fresh blood is needed who can perform some of the grunt work -- I'm
ready to move on to polishing :)
Quote:
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.
Exactly -- hence why we need more people to participate. I'm hoping
the new framework you are coming up with will make it easier to allow
contributions from many people, and for each of them to not require
such a huge dedication of time to writing full chapters -- but able to
focus on some very specific part of Asterisk and document the heck
outta it. This seems to be how Asterisk works in many circles -- a
keen focus on a particular area, with little or no knowledge about
other areas.
Peter, thanks for taking on this new project -- please let me know if
I can be of any assistance -- I recommend you get on IRC and just idle
and ask questions as you come across them. In fact, that goes for
anyone interested in documentation.
Thanks!
Leif Madsen.
_______________________________________________
--Bandwidth and Colocation provided by Easynews.com --
You cannot post new topics in this forum You cannot reply to topics in this forum You cannot edit your posts in this forum You cannot delete your posts in this forum You cannot vote in polls in this forum