Re: [asterisk-users] Asterisk Documentation now on voip-info.org Wiki

2008-10-01 Thread Olivier
+1 !
Great !
___
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

AstriCon 2008 - September 22 - 25 Phoenix, Arizona
Register Now: http://www.astricon.net

asterisk-users mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-users

Re: [asterisk-users] Asterisk Documentation now on voip-info.org Wiki

2008-10-01 Thread Rob Hillis
Josiah Bryan wrote:
 The script design supports plugin formatting as it stands. E.g. I can 
 insert any formatting algorithm if anyone has any suggestions. Right 
 now, the formatter script just does:

 #!/usr/bin/perl
 use strict;

 my $file = $ARGV[0];

 print ~pp~\n;
 print `cat $file`;
 print ~/pp~\n;

 Any formatting can be added as desired - this was just a quick way to 
 get the content online.
   

Might I suggest including...

print -=NOTE: These pages are automatically updated once per 
day/week/month/year/decade from the Asterisk subversion repository.  Any 
changes made to this page will be automatically overwritten with the 
latest version from insert URL here.\n;

...at the beginning?  May stop some nutters whining that you're 
continually overwriting their changes.

___
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

AstriCon 2008 - September 22 - 25 Phoenix, Arizona
Register Now: http://www.astricon.net

asterisk-users mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-users


Re: [asterisk-users] Asterisk Documentation now on voip-info.org Wiki

2008-10-01 Thread Josiah Bryan
Rob Hillis wrote:
 Josiah Bryan wrote:
 Any formatting can be added as desired - this was just a quick way to 
 get the content online.
   
 
 Might I suggest including...
 
 print -=NOTE: These pages are automatically updated once per 
 day/week/month/year/decade from the Asterisk subversion repository.  Any 
 changes made to this page will be automatically overwritten with the 
 latest version from insert URL here.\n;
 
 ...at the beginning?  May stop some nutters whining that you're 
 continually overwriting their changes.
 

Good point - I'll get that in there after breakfast :-). Seriously, good 
point though.


-- 
Josiah Bryan
IT Manager
Productive Concepts, Inc.
[EMAIL PROTECTED]
(765) 964-6009, ext. 224


___
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

AstriCon 2008 - September 22 - 25 Phoenix, Arizona
Register Now: http://www.astricon.net

asterisk-users mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-users


[asterisk-users] Asterisk Documentation now on voip-info.org Wiki

2008-09-30 Thread Josiah Bryan
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.
[EMAIL PROTECTED]
(765) 964-6009, ext. 224


___
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

AstriCon 2008 - September 22 - 25 Phoenix, Arizona
Register Now: http://www.astricon.net

asterisk-users mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-users


Re: [asterisk-users] Asterisk Documentation now on voip-info.org Wiki

2008-09-30 Thread Steve Totaro
On Tue, Sep 30, 2008 at 11:32 AM, Josiah Bryan 
[EMAIL PROTECTED] 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.
 [EMAIL PROTECTED]
 (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)
___
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

AstriCon 2008 - September 22 - 25 Phoenix, Arizona
Register Now: http://www.astricon.net

asterisk-users mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-users

Re: [asterisk-users] Asterisk Documentation now on voip-info.org Wiki

2008-09-30 Thread Tzafrir Cohen
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:[EMAIL PROTECTED]
+972-50-7952406   mailto:[EMAIL PROTECTED]
http://www.xorcom.com  iax:[EMAIL PROTECTED]/tzafrir

___
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

AstriCon 2008 - September 22 - 25 Phoenix, Arizona
Register Now: http://www.astricon.net

asterisk-users mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-users


Re: [asterisk-users] Asterisk Documentation now on voip-info.org Wiki

2008-09-30 Thread Josiah Bryan

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.
[EMAIL PROTECTED]
(765) 964-6009, ext. 224


___
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

AstriCon 2008 - September 22 - 25 Phoenix, Arizona
Register Now: http://www.astricon.net

asterisk-users mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-users


Re: [asterisk-users] Asterisk Documentation now on voip-info.org Wiki

2008-09-30 Thread Mark Hamilton
I'm game. It's just perfect the way it is - long overdue!
On my behalf, and behalf of the community (hopefully?), thanks a lot Mr.
Bryan for taking the initiative to get this done.


-Original Message-
From: [EMAIL PROTECTED]
[mailto:[EMAIL PROTECTED] On Behalf Of Josiah Bryan
Sent: September 30, 2008 1:35 PM
To: asterisk-users@lists.digium.com
Subject: Re: [asterisk-users] Asterisk Documentation now on voip-info.org
Wiki


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.
[EMAIL PROTECTED]
(765) 964-6009, ext. 224


___
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

AstriCon 2008 - September 22 - 25 Phoenix, Arizona
Register Now: http://www.astricon.net

asterisk-users mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-users


___
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

AstriCon 2008 - September 22 - 25 Phoenix, Arizona
Register Now: http://www.astricon.net

asterisk-users mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-users


Re: [asterisk-users] Asterisk Documentation now on voip-info.org Wiki

2008-09-30 Thread Tzafrir Cohen
On Tue, Sep 30, 2008 at 01:35:00PM -0400, Josiah Bryan wrote:
 
 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.

Do you intend to add that formatting in your script? They can't be
changed manually.

 
 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.

http://svn.digium.com/svn/asterisk/branches/1.6.0/doc/callfiles.txt

Looks better.

-- 
   Tzafrir Cohen
icq#16849755  jabber:[EMAIL PROTECTED]
+972-50-7952406   mailto:[EMAIL PROTECTED]
http://www.xorcom.com  iax:[EMAIL PROTECTED]/tzafrir

___
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

AstriCon 2008 - September 22 - 25 Phoenix, Arizona
Register Now: http://www.astricon.net

asterisk-users mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-users


Re: [asterisk-users] Asterisk Documentation now on voip-info.org Wiki

2008-09-30 Thread Josiah Bryan
Tzafrir Cohen wrote:
 On Tue, Sep 30, 2008 at 01:35:00PM -0400, Josiah Bryan wrote:
 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.
 
 Do you intend to add that formatting in your script? They can't be
 changed manually.

The script design supports plugin formatting as it stands. E.g. I can 
insert any formatting algorithm if anyone has any suggestions. Right 
now, the formatter script just does:

#!/usr/bin/perl
use strict;

my $file = $ARGV[0];

print ~pp~\n;
print `cat $file`;
print ~/pp~\n;

Any formatting can be added as desired - this was just a quick way to 
get the content online.


 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.
 
 http://svn.digium.com/svn/asterisk/branches/1.6.0/doc/callfiles.txt
 
 Looks better.

I agree - if you're looking for the change log. However, I (if I were a 
first-time asterisk user) probably don't care for the change-log-esque 
view, I just want to read the text for myself.

However, I'd be happy to add links to the svn at the bottom of the page 
if that is desired. Thoughts?

Cheers!
-josiah

-- 
Josiah Bryan
IT Manager
Productive Concepts, Inc.
[EMAIL PROTECTED]
(765) 964-6009, ext. 224


___
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

AstriCon 2008 - September 22 - 25 Phoenix, Arizona
Register Now: http://www.astricon.net

asterisk-users mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-users


Re: [asterisk-users] Asterisk Documentation now on voip-info.org Wiki

2008-09-30 Thread Steve Totaro
On Tue, Sep 30, 2008 at 2:40 PM, Josiah Bryan [EMAIL PROTECTED]
 wrote:

 Tzafrir Cohen wrote:
  On Tue, Sep 30, 2008 at 01:35:00PM -0400, Josiah Bryan wrote:
  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.
 
  Do you intend to add that formatting in your script? They can't be
  changed manually.

 The script design supports plugin formatting as it stands. E.g. I can
 insert any formatting algorithm if anyone has any suggestions. Right
 now, the formatter script just does:

 #!/usr/bin/perl
 use strict;

 my $file = $ARGV[0];

 print ~pp~\n;
 print `cat $file`;
 print ~/pp~\n;

 Any formatting can be added as desired - this was just a quick way to
 get the content online.


  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.
 
  http://svn.digium.com/svn/asterisk/branches/1.6.0/doc/callfiles.txt
 
  Looks better.

 I agree - if you're looking for the change log. However, I (if I were a
 first-time asterisk user) probably don't care for the change-log-esque
 view, I just want to read the text for myself.

 However, I'd be happy to add links to the svn at the bottom of the page
 if that is desired. Thoughts?

 Cheers!
 -josiah

 --
 Josiah Bryan
 IT Manager
 Productive Concepts, Inc.
 [EMAIL PROTECTED]
 (765) 964-6009, ext. 224


I think there should be links for changelogs and links for every different
language, so script that up ASAP :-P

I only bother with the changelog to see why something may be broken or if an
upgrade might fix something.  I don't think too many people care about it on
the wiki anyways.

-- 
Thanks,
Steve Totaro
1.888.777.1888
1.240.938.1212 (cell)
___
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

AstriCon 2008 - September 22 - 25 Phoenix, Arizona
Register Now: http://www.astricon.net

asterisk-users mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-users