[hobbit] Working on Xymon Documentation

[TJ Yang]

Hi, Josh
Thanks for offering the help on Xymon Diagrams using Dia.
I will upload a few xymon dia files that I drawed as template for you
to carry on.

There are many questions can be easily illustrated using dia.
1. What are relationships between hobbid and hobbit worker daemon ?
2. What kind of log files generated by which daemons ?
3. What is program layout of Hobbit server ?
4. What is program layout of hobbit clients ?
5. What is hobbit message looks like ?
6. What is Xymon High Availability on LAN ?
7. What is  Xymon High Availability over WAN ?
8. What is relationship of hobbit client binary and log files?
...


tj

On Sat, Jul 3, 2010 at 8:48 PM, Josh Luthman
<josh at imaginenetworksllc.com> wrote:
> I can offer my help with 2 and 3.  I am by no means an expert, though.
>
> On 7/3/10, TJ Yang <tjyang2001 at gmail.com> wrote:
>> On Sat, Jul 3, 2010 at 2:22 PM, Josh Luthman
>> <josh at imaginenetworksllc.com> wrote:
>>> Would you like me to proof before it is published?
>>
>> Proof read is not needed yet.
>>
>> Need people that know (or not afraid of ) following keywords.
>> 1. LaTeX/latex2pdf and basic svn skill.
>> 2. Use dia do draw some xymon architecture diagrams.
>> 3. Knowledge of Xymon client and server.
>> 4. technical writing on Xymon subjects.
>> 5. GNU Make.
>> 6. Have Fedora 1X OS at home, or willing to login into my home
>>     Fedora 13 machine for the above work.
>>
>>
>> What I have so far,
>>
>> 1. Xymon RTFM, the latex version of Henrik's doc work.
>>    1.1 Need many updates since Hobbit has Has been reamed to Xymon.
>>    1.2 Need much labor work to index keywords to generate correct index.
>>          A very good example to use divide and conquer method with the help
>>          of a few people.
>>
>> Following is vaporware.
>>
>> 2. Turn/enhance  Xymon Wiki book into LaTeX format.
>>     Reuse Xymon RTFM book making framework to generate
>>     2.1 Developer Guide.
>>     2.2 User Guide.
>>     2.3 Administrator Guide.
>>     2.4 Overview slide.
>>
>> I will try to upload(not publish!!) the Xymon RTFM during this July 4th
>> weekend.
>>
>> tj
>>> On 7/3/10, TJ Yang <tjyang2001 at gmail.com> wrote:
>>>> According to R1, we now have 7 volunteers interested in Xymon
>>>> documentation area.
>>>>
>>>> I am interested to find out who are willing to work on Item 2 of R2.
>>>>
>>>> I started a few years back and never got to finish it.
>>>> Henrik gave me S.F. commit privilege for this purpose. so I still own
>>>> him the set of docs.
>>>>
>>>> I worked on this and later found I am really bad at English Writing.
>>>> So I try to convert the troff files
>>>> into latex file and have the book center around existing set of troff
>>>> files.
>>>> I got a RTFM xymon book for my me and my colleague to study Xymon with.
>>>>
>>>> New I have a two data sources issue, latex and troff files. So every
>>>> time troff files changed
>>>> latex file need to be changed as well. This is quite labor intensive.
>>>>
>>>> I looked around and found there is latex2troff file converter, the
>>>> make process can generate troff file.
>>>> If we can have all team members use latex then we can generate all
>>>> Xymon doc into different formats use latex.
>>>>
>>>> For now I like to invite people interested about this xymon-latex
>>>> project to join me.
>>>> I will clean up and upload my existing work to S.F.
>>>> sandbox/tjyang/docs directory.
>>>>
>>>> Lots of work here to generate Xymon docs set(using latex)
>>>>
>>>> Please help.
>>>>
>>>> Regards
>>>>
>>>> tj
>>>>
>>>>
>>>> R1:
>>>> http://en.wikibooks.org/wiki/System_Monitoring_with_Xymon/Developer_Guide#Xymon_volunteers_Roles_and_Responsiblity
>>>> R2:
>>>> http://en.wikibooks.org/wiki/System_Monitoring_with_Xymon/Developer_Guide#Xymon_Documentation
>>>> --
>>>> T.J. Yang
>>>>
>>>> To unsubscribe from the hobbit list, send an e-mail to
>>>> hobbit-unsubscribe at hswn.dk
>>>>
>>>>
>>>>
>>>
>>>
>>> --
>>> Josh Luthman
>>> Office: 937-552-2340
>>> Direct: 937-552-2343
>>> 1100 Wayne St
>>> Suite 1337
>>> Troy, OH 45373
>>>
>>> “Success is not final, failure is not fatal: it is the courage to
>>> continue that counts.”
>>> --- Winston Churchill
>>>
>>> To unsubscribe from the hobbit list, send an e-mail to
>>> hobbit-unsubscribe at hswn.dk
>>>
>>>
>>>
>>
>>
>>
>> --
>> T.J. Yang
>>
>> To unsubscribe from the hobbit list, send an e-mail to
>> hobbit-unsubscribe at hswn.dk
>>
>>
>>
>
>
> --
> Josh Luthman
> Office: 937-552-2340
> Direct: 937-552-2343
> 1100 Wayne St
> Suite 1337
> Troy, OH 45373
>
> “Success is not final, failure is not fatal: it is the courage to
> continue that counts.”
> --- Winston Churchill
>
> To unsubscribe from the hobbit list, send an e-mail to
> hobbit-unsubscribe at hswn.dk
>
>
>



-- 
T.J. Yang