asterisk users - Sep 2008 - Asterisk Documentation now on voip-info.org Wiki

Hey All -

Per a discussion earlier, I've setup a small cron job on one of my 
servers that automatically updates voip-info.org wiki with the latest 
and greatest Asterisk Documentation, straight from svn (specifically, 
the /branches/$version/doc folder for each version.) The files are 
located under 'Asterisk Documentation' on voip-info.org:

Link to the index page:

     http://www.voip-info.org/wiki/view/Asterisk+Documentation


It currently polls the following Asterisk branches from subversion:
     * 1.2
     * 1.4
     * 1.6.0
     * 1.6.1

---------------------------------------
Let me know what you think. If anyone has any questions or comments, 
please do let me know. Oh, and many thanks to James Thompson of 
voip-info.org for his quick response to my questions about an API for 
updating pages. His help was invaluable.

---------------------------------------
Technical Specifics about the Cron Job:
---------------------------------------

The cron job runs daily (about 4am EST) and does an 'svn update' for 
each version's 'doc' folder. If there are any changes, the job
uploads
ONLY the 'text/plain' files in the folder to the wiki (prefixing the 
pages with 'Asterisk Documentation '+$version+' '+$filename, so 
/branches/1.6.1/doc/callfiles.txt becomes 'Asterisk Documentation 1.6.1 
callfiles.txt': 
http://www.voip-info.org/wiki/view/Asterisk+Documentation+1.6.1+callfiles.txt

Note that right now, the files are just passed straight to the wiki and 
quoted in a '~pp~' block (essentially, a <pre> block) - formatting
can
be applied later if requested - and if presented with a reliable 
formatting algorithm.

Let me know what you all think. Cheers!
-josiah

-- 
Josiah Bryan
IT Manager
Productive Concepts, Inc.
jbryan at productiveconcepts.com
(765) 964-6009, ext. 224

On Tue, Sep 30, 2008 at 11:32 AM, Josiah Bryan <
jbryan at productiveconcepts.com> wrote:
> Hey All -
>
> Per a discussion earlier, I've setup a small cron job on one of my
> servers that automatically updates voip-info.org wiki with the latest
> and greatest Asterisk Documentation, straight from svn (specifically,
> the /branches/$version/doc folder for each version.) The files are
> located under 'Asterisk Documentation' on voip-info.org:
>
> Link to the index page:
>
>     http://www.voip-info.org/wiki/view/Asterisk+Documentation
>
>
> It currently polls the following Asterisk branches from subversion:
>     * 1.2
>     * 1.4
>     * 1.6.0
>     * 1.6.1
>
> ---------------------------------------
> Let me know what you think. If anyone has any questions or comments,
> please do let me know. Oh, and many thanks to James Thompson of
> voip-info.org for his quick response to my questions about an API for
> updating pages. His help was invaluable.
>
> ---------------------------------------
> Technical Specifics about the Cron Job:
> ---------------------------------------
>
> The cron job runs daily (about 4am EST) and does an 'svn update'
for
> each version's 'doc' folder. If there are any changes, the job
uploads
> ONLY the 'text/plain' files in the folder to the wiki (prefixing
the
> pages with 'Asterisk Documentation '+$version+'
'+$filename, so
> /branches/1.6.1/doc/callfiles.txt becomes 'Asterisk Documentation 1.6.1
> callfiles.txt':
>
>
http://www.voip-info.org/wiki/view/Asterisk+Documentation+1.6.1+callfiles.txt
>
> Note that right now, the files are just passed straight to the wiki and
> quoted in a '~pp~' block (essentially, a <pre> block) -
formatting can
> be applied later if requested - and if presented with a reliable
> formatting algorithm.
>
> Let me know what you all think. Cheers!
> -josiah
>
> --
> Josiah Bryan
> IT Manager
> Productive Concepts, Inc.
> jbryan at productiveconcepts.com
> (765) 964-6009, ext. 224
>
>
Coolness.  I will check it out.  Seems like something that should have been
done ages ago.

-- 
Thanks,
Steve Totaro
1.888.777.1888
1.240.938.1212 (cell)
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
http://lists.digium.com/pipermail/asterisk-users/attachments/20080930/b12674c5/attachment.htm

On Tue, Sep 30, 2008 at 11:32:41AM -0400, Josiah Bryan
wrote:
> Hey All -
> 
> Per a discussion earlier, I've setup a small cron job on one of my 
> servers that automatically updates voip-info.org wiki with the latest 
> and greatest Asterisk Documentation, straight from svn (specifically, 
> the /branches/$version/doc folder for each version.) The files are 
> located under 'Asterisk Documentation' on voip-info.org:
> 
> Link to the index page:
> 
>      http://www.voip-info.org/wiki/view/Asterisk+Documentation
> 
> 
> It currently polls the following Asterisk branches from subversion:
>      * 1.2
>      * 1.4
>      * 1.6.0
>      * 1.6.1
Why not link to the SVN instead?

-- 
               Tzafrir Cohen
icq#16849755              jabber:tzafrir.cohen at xorcom.com
+972-50-7952406           mailto:tzafrir.cohen at xorcom.com
http://www.xorcom.com  iax:guest at local.xorcom.com/tzafrir

Tzafrir Cohen wrote:
> On Tue, Sep 30, 2008 at 11:32:41AM -0400, Josiah Bryan wrote:
>> Hey All -
>>
>> Link to the index page:
>>
>>      http://www.voip-info.org/wiki/view/Asterisk+Documentation
>>
> Why not link to the SVN instead?
I considered that as well. My thoughts:

1) Ungoogleabelness (if thats a word :-) - since google already ranks 
voip-info.org high on search for asterisk related content, I thought the 
docs should be where the users are, not vis-a-versa.

2) Formatability - the docs are plain text in subversion, whereas 
putting the in the wiki offers the possibility for formatting and 
auto-linking as the algorithm presents itself.

2) UI similarity - linking to the file on svn, for example:

http://svn.digium.com/view/asterisk/branches/1.6.0/doc/callfiles.txt?view=co

Brings just the plain text view, whereas putting it in the wiki offers 
the same UI as the rest of the site.


Note that all these comments are merely my thoughts - feel free to 
comment against them at will. If desired, I can update the index page 
generator to just put links to the svn instead.

Cheers!
-josiah



-- 
Josiah Bryan
IT Manager
Productive Concepts, Inc.
jbryan at productiveconcepts.com
(765) 964-6009, ext. 224

+1 !
Great !
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
http://lists.digium.com/pipermail/asterisk-users/attachments/20081001/df9cd99a/attachment.htm