Edit: I wish I could change the subject to "Thoughts on 1.6 documentation" as that more closely fits how I feel. :-) Sorry for the bad thread title.
Here's a sample of some corrections/errors in the latest documentation. I must say I am quite pleased with the level of documentation on this version! Good work!
I have divided this post into two sections, thoughts and posts.
Thoughts:
Database size description. GREAT!
zabbix_agent(d) -p (Never noticed this before, cool!)
I only had a chance to get through the first 65 or so pages. Overall I'm very impressed with the background discussion and descriptions. I look forward to reading through the rest in the next few days. Many thanks to those who helped write this. Forgive me if my "errors" seem like nitpicks, I know they may seem minor but they make reading much easier. :-)
Errors (Ya I know some of these are nitpicks)
Page 30 (Database Size)
In the number of processed values per second paragraph at the bottom, it is first stated that there are 4000 items to monitor, yet the calculation is done with 3000 items.
------
Page 31
In "Housekeeper settings for history"
Origional fragment: "seconds, total number of values will be around (30*24*3600)*50 = 129.600.000, or about 130M of values."
Change to "seconds, total number of values will be around (30*24*3600)*50 = 129.600.000,
or about 130M values." (remove last "of")
------
Page 32
Original: "Disk space requirements for nodes in distributed setup are calculated in a
similar way, but this also depends on a total number of child nodes linked to a
node."
Change to: "Disk space requirements for nodes in a distributed setup are calculated in a
similar way, but this also depends on a total number of child nodes linked to a
node."
Added "a" after "nodes in"
------
Page 32
Origional: "It is very important to have precise system date on server with ZABBIX running.
timed is one of most popular daemons that synchronizes the host’s time with the
time of other machines."
This paragraph is just awkward. How about something like this
"It is very important that all Zabbix servers be time synchronized. There are many ways to perform time synchronization between servers the use of "timed" is a common and popular means of accomplishing this goal. Consult your system documentation for further discussion and configuration information."
------
Page 34
Section 2.3.5
The paragraph about the web interface is awkward. Consider reworking.
------
Page 46
Has the timezone check been removed? If not consider adding a note about where to find configuration information for this.
-----
Page 51
The first sentence could probably use some reworking.
Original "where Node ID is an unique Node identificator."
Proposed Change "Where Node ID is a unique identification number."
-----
All tables
Consider turning off full justification in the table. The extra spacing makes the text harder to read.
Here's a sample of some corrections/errors in the latest documentation. I must say I am quite pleased with the level of documentation on this version! Good work!
I have divided this post into two sections, thoughts and posts.
Thoughts:
Database size description. GREAT!
zabbix_agent(d) -p (Never noticed this before, cool!)
I only had a chance to get through the first 65 or so pages. Overall I'm very impressed with the background discussion and descriptions. I look forward to reading through the rest in the next few days. Many thanks to those who helped write this. Forgive me if my "errors" seem like nitpicks, I know they may seem minor but they make reading much easier. :-)
Errors (Ya I know some of these are nitpicks)
Page 30 (Database Size)
In the number of processed values per second paragraph at the bottom, it is first stated that there are 4000 items to monitor, yet the calculation is done with 3000 items.
------
Page 31
In "Housekeeper settings for history"
Origional fragment: "seconds, total number of values will be around (30*24*3600)*50 = 129.600.000, or about 130M of values."
Change to "seconds, total number of values will be around (30*24*3600)*50 = 129.600.000,
or about 130M values." (remove last "of")
------
Page 32
Original: "Disk space requirements for nodes in distributed setup are calculated in a
similar way, but this also depends on a total number of child nodes linked to a
node."
Change to: "Disk space requirements for nodes in a distributed setup are calculated in a
similar way, but this also depends on a total number of child nodes linked to a
node."
Added "a" after "nodes in"
------
Page 32
Origional: "It is very important to have precise system date on server with ZABBIX running.
timed is one of most popular daemons that synchronizes the host’s time with the
time of other machines."
This paragraph is just awkward. How about something like this
"It is very important that all Zabbix servers be time synchronized. There are many ways to perform time synchronization between servers the use of "timed" is a common and popular means of accomplishing this goal. Consult your system documentation for further discussion and configuration information."
------
Page 34
Section 2.3.5
The paragraph about the web interface is awkward. Consider reworking.
------
Page 46
Has the timezone check been removed? If not consider adding a note about where to find configuration information for this.
-----
Page 51
The first sentence could probably use some reworking.
Original "where Node ID is an unique Node identificator."
Proposed Change "Where Node ID is a unique identification number."
-----
All tables
Consider turning off full justification in the table. The extra spacing makes the text harder to read.
Comment