[ZBX-22437] Zabbix v6.0.x documentation issues, part 2 Created: 2023 Mar 01 Updated: 2024 Apr 10 Resolved: 2023 Apr 28 |
|
Status: | Closed |
Project: | ZABBIX BUGS AND ISSUES |
Component/s: | Documentation (D) |
Affects Version/s: | 6.0.13 |
Fix Version/s: | 6.0.18rc1, 6.4.3rc1, 7.0.0alpha1, 7.0 (plan) |
Type: | Documentation task | Priority: | Trivial |
Reporter: | Constantin Oshmyan | Assignee: | Arturs Dancis |
Resolution: | Fixed | Votes: | 0 |
Labels: | None | ||
Remaining Estimate: | Not Specified | ||
Time Spent: | Not Specified | ||
Original Estimate: | Not Specified |
Issue Links: |
|
||||||||||||||||||||
Team: | |||||||||||||||||||||
Sprint: | Sprint 98 (Mar 2023), Sprint 99 (Apr 2023) | ||||||||||||||||||||
Story Points: | 2 |
Description |
This is a continuation of
|
Comments |
Comment by Constantin Oshmyan [ 2023 Mar 01 ] |
The "Agent" pageThe "Supported platform" section does not list HP-UX and NetBSD. The "Red Hat Enterprise Linux" pageThe "SELinux configuration" section has the phrase:
"RHEL 8" and "RHEL 7" are the links; however, they lead to the same place. The second one (for RHEL 7) should be: (http://repo.zabbix.com/zabbix/6.0/rhel/7/SRPMS/). The "Item keys specific to agent 2"This page has the very first sentense:
The words "Unix" and "Windows" are a links to another pages; however, the link under the "Windows" is broken (it seems that some part of link has been duplicated). The next paragraph: "See also: Plugins supplied out-of-the-box" also contains broken link: the target page does not have the "#plugins-supplied-out-of-the-box" section. The same page, a bit later: descriptions of "ceph.osd.discovery" and "ceph.pool.discovery" metrics both contain a link to discovery of systemd services. The same page, "pgsql.dbstat" metric: descriptions of dependent items "pgsql.dbstat.numbackends" and "pgsql.dbstat.sum.blk_read_time" are the same. It seems that first of them is wrong (result of copy-paste). |
Comment by Constantin Oshmyan [ 2023 Mar 01 ] |
The "Windows-specific item keys" pageThis page has the following sentence:
However, it's unclear: where they "are". Value maps were global before: Administration -> General; but currently they are a property of the host or template only. The "SNMP traps" pageThe section "Configuring Perl trap receiver" has near the end instruction:
The example that followed has a broken formatting (2 lines merged into a single line). The same is true a bit later in the "Configuring SNMPTT" section, after instruction:
The same section, the example for a date/time format is: date_time_format = %H:%M:%S %Y/%m/%d = [DATE TIME FORMAT] Probably, the last part of this line ("= [DATE TIME FORMAT]") is not needed (see the example here for this parameter). The same page, the section "SNMPv3" has this instruction:
However, there are 2 line to add; so there should be "the following lines" (with "s" ending for plural). The same page, the very last example: it's unclear why the value of Zabbix item in this example has a different time and source UDP port comparing to values from the file snmptraps.log. |
Comment by Constantin Oshmyan [ 2023 Mar 01 ] |
The "Simple checks" pageTable "Supported simple checks": the key name "net.udp.service[service,<ip>,<port>]" should be emphasized by bold. The "VMware monitoring item keys" pageThis page begins with the "vmware.cl.perfcounter" metric, but it's unclear what is the "performance counter path" parameter. And just note from me as a translator: the table on this page is very big, it's hard to work when a continuous text fragment is so huge. The "Internal checks" pageThe table contains metric zabbix[host,,items_unsupported]: comment contains a star ("*") at the end (like it is a footnote), but there is no footnotes on this page. The "SSH checks" pageThe beginning of this page has link "See also: Requirements" at the second paragraph. The same section has a note: "Only libssh is supported starting with RHEL 8." The same page a bit later: the "Configuration" section has the subsection named "Passphrase authentication". The "Trapper items" pageThe table here tells that the "Allowed hosts" field can contain IP addresses or hostnames. |
Comment by Constantin Oshmyan [ 2023 Mar 01 ] |
The "JMX monitoring" pageThe "Simple attributes" section contains the last sentence starting with:
The part of an object name in source code is in the angle brackets, so on the web this part seems like a link; but this link is invalid in any case. A bit later on the same page, the "Other issues" section contains a broken link (the section name "##parameter---quoted-string" contains doubled "#" symbol). The same page later, section "Using custom endpoint with JBoss EAP 6.4":
|
Comment by Constantin Oshmyan [ 2023 Mar 01 ] |
The "ODBC monitoring" pageIn the "Installing unixODBC" and "Installing unixODBC drivers" sections:
and then example of usage the dnf. So, which package manager is used – yum or dnf? The "Item configuration in Zabbix frontend" section: description of the "key" parameter has broken link to example. The "HTTP agent" pageThe "Overview" section has the broken link to the " known issues" (there is no the "#https-checks" section on that page). |
Comment by Constantin Oshmyan [ 2023 Mar 16 ] |
The "Script items" pageThe "Data collection with parameters" example does not demonstrate the parameters usage: the provided code does not use the parameter in this example ("host" in this case), so it's still unclear how it could be accessed from the JavaScript. |
Comment by Constantin Oshmyan [ 2023 Mar 21 ] |
The "Loadable modules" pageThe last paragraph of this section is:
It's unclear, however, the beginning of the last sentense: what exactly will fail – a separate module or an entire agent? The same page, a bit later: the code example of dummy module has several misprints in the dummy_echo and dummy_random functions. |
Comment by Marina Generalova [ 2023 Mar 30 ] |
Dear constantin.oshmyan, thank you for your impact reporting documentation bugs. Kindly, create a new task for April finds if (or, most likely, when) there are more issues detected - once a month seems to be a good rhythm for such tasks. Meanwhile, we will start working on this one. By the way, most of the |
Comment by Constantin Oshmyan [ 2023 Mar 30 ] |
mgeneralova, Yes, of course. OK. Thank you! |
Comment by Brian van Baekel [ 2023 Mar 30 ] |
mgeneralova i am wondering, if ctrl+enter or cmd+enter still works for reporting documentation issues? I report them via that way (and do not create tickets) but if ctrl+enter or cmd+enter doesn't work anymore, that is wasted effort and it might be a good idea to have a generic ZBX open to report documentation issues? |
Comment by Marina Generalova [ 2023 Mar 30 ] |
brian.baekel typo reports via ctrl/cmd+enter still work (and we are not planning to remove this functionality), please feel free to use whichever option is more convenient to you. |
Comment by Arturs Dancis [ 2023 Apr 28 ] |
Thank you for reporting! Documentation updated:
|
Comment by Constantin Oshmyan [ 2023 Apr 28 ] |
adancis wrote:
Thanks, great! |
Comment by Constantin Oshmyan [ 2023 May 18 ] |
Just some shortcomings:
A description of the "pgsql.db.age" item still has the phrase "Used for low-level discovery", however it returns the Integer value (link).
This broken link is not fixed yet. |
Comment by Arturs Dancis [ 2023 May 19 ] |
Thank you for pointing out the shortcomings! Documentation updated: |