[ZBX-23129] Zabbix v6.0.x documentation issues, part 4 Created: 2023 Jul 19  Updated: 2024 Apr 10  Resolved: 2024 Feb 12

Status: Closed
Project: ZABBIX BUGS AND ISSUES
Component/s: Documentation (D)
Affects Version/s: 6.0.19
Fix Version/s: 7.0.0beta2, 7.0 (plan)

Type: Documentation task Priority: Trivial
Reporter: Konstantīns Ošmjans Assignee: Martins Valkovskis
Resolution: Fixed Votes: 1
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File screenshot-2023-07-20_01.PNG    
Issue Links:
Sub-task
depends on ZBX-23960 Zabbix v6.0.x documentation issues, p... Closed
depends on ZBX-24176 Zabbix v6.0.x documentation issues, p... Closed
Team: Team C
Sprint: Sprint 102 (Jul 2023), Sprint 103 (Aug 2023), Sprint 104 (Sep 2023), Sprint 105 (Oct 2023), Sprint 106 (Nov 2023), Sprint 107 (Dec 2023), Sprint candidates, S2401
Story Points: 0.5

 Description   

This is a continuation of ZBX-22233, ZBX-22437 and ZBX-22819 (it could be great to link it here; unfortunately, I have no such permissions).

During my work on documentation translation, I sometimes run into issues with the original (English) version of documentation.
In most cases they are small: broken links or broken formatting.
Probably, it is inefficient to create a separate ZBX on each of them, so I'll summarize just a lot of details in comments below.
[...]
Just note: I'm writing these comments reading the current version of documentation about Zabbix 6.0.
Probably, some of them (or, maybe, most of them) relates to the later versions, too (6.2 and 6.4); I didn't check that.



 Comments   
Comment by Konstantīns Ošmjans [ 2023 Jul 19 ]

The "Internal checks" page

The main table here contains misprint for the "zabbix[process,<type>,<mode>,<state>]" item: comment for the "Supported types of proxy processes" lists "odbs poller" process (there should be "odbc poller").

The "Plugins" page

The Parameter priority section has a broken link to picture (the image is not rendered).

The "Configuring a network map" page

The "Adding elements" section has the following sentence:

(Random elements can later again be aligned to the grid with the Align map elements button.)

However, the Align map does not seem as a button, it looks like a link.

The "Configuring a template" page

The "Adding items, triggers, graphs" section has the following sentence:

Go to Data collectionHosts (or Templates).

However, there is no "Data collection" menu in the version 6.0.x. Probably, there should be "Configuration" menu.

Comment by Konstantīns Ošmjans [ 2023 Jul 19 ]

The "HTTP template operation" page

There are several notes for this page.
First of all, this page contain a single huge table, so it's very hard to work with it (for example, to find the place where the change has been made to modify the translation accordingly).
Additionally:

  • examples of executed commands sometimes are doubtful or bad-formatted. For example, they contain extra quotings (excessive "'" or '"' characters), unneeded backslashes before the pipe (|) character, or unclear percentage (%) characters.
    Check, please, at least the descriptions of the "Etcd by HTTP", "NGINX by HTTP", "RabbitMQ cluster by HTTP" templates.
  • there is no consistency in the format of description for different templates. For example:
    • empty default macro's values: in some places – '', somewhere – ``, in some more places – "not set";
    • descriptions of macro's: somewhere – from the lowercase, somewhere – from the uppercase;
  • The very last template (for ZooKeeper) has misspelled macro "{ZOOKEEPER.PORT}" (there should be the dollar sign: "{$ZOOKEEPER.PORT}").

The "ODBC template operation" page

The step 3 on this page (at the beginning of page, before the main table) contains a link "ODBC monitoring".
This link is a bit wrong: 1) it contains a full path (instead of relative path, that could cause to mistakes in the translated versions), 2) it contains an unnecessary highlighting.

Comment by Konstantīns Ošmjans [ 2023 Jul 19 ]

The "Zabbix agent 2 template operation" page

This page contains description for the "Ceph by Zabbix agent 2" template, where the "{$CEPH.CONNSTRING} macro is commented as:

can be a session name or a URI defined in the following format: <protocol(host:port)>

However, the example contradicts this strange format: it does not contain any parentheses but follows a standard URI format (including "://" between the protocol and host).
The same note is true for the both MongoDB templates as well as "MySQL by Zabbix agent 2", "Oracle by Zabbix agent 2" and "PostgreSQL Agent 2" templates, too.
Moreover, the MongoDB commands in the last column of the table have a wrong format: 1) unpaired quotes: the last character should be apostrophe (') instead of double-quote ("); 2) there should be comment that the macro's in this commands should be expanded manually by a user.
The "PostgreSQL Agent 2" template has a strange commands in the last column: it seems like a page break is missed; moreover - the "GRANT" these commands differ from the command in the README for this template.
The "Website certificate by Zabbix agent 2" template: bad formatting of the macro name (there should be bold).

The "Zabbix agent template operation" page

The first step (at the very beginning of the page) contains the sentence:

For active checks, also make sure that the host is added to the 'ServerActive' parameter of the agent configuration file.

This is wrong: the 'ServerActive' parameter should contain the Zabbix server, not host. At the same time, it is also critical to have a correct host name in the 'Hostname' parameter.
Examples of commands (at least, for Apache and Nginx) in the last column are broken: the pipeline is just "|" character, without an additional backslash before it.
The "MySQL by Zabbix agent" has the bad description of the step 4: 1) the term "home directory" relates to user, not to agent; 2) example of ".my.cnf" file is broken: it contains too many quotes.
The note about "home directory" relates to the "PostgreSQL" template, too.

Comment by Konstantīns Ošmjans [ 2023 Jul 19 ]

The "Operations" page

The "Operation details" section contains a table, where the "Steps" and "Duration" fields have no any descriptions.
Possibly, a link to escalations could be useful here.

The "Sending message" page

The "Tracking messages" section contains this sentence:

If you click on the event time to view event details, you will also see the Message actions block containing details of messages sent (or not sent) due to the event.

However, actually there is no block named "Message actions". There are the following blocks there: "Trigger details", "Event details", "Actions" and "Event list [previous 20]".

Comment by Edgar Akhmetshin [ 2023 Jul 19 ]

Hello Constantin,

Thank you for reporting this issue. Confirmed.

Regards,
Edgar

Comment by Konstantīns Ošmjans [ 2023 Jul 20 ]

The "Recovery operations" page

The "Recovery operation details" section has a broken formatting just under the first screenshot. The text after "Three operation types are available for recovery events:" phrase, probably, should be formatted as a list.

The "Macro functions" page

Some notes regarding this page.

  • There is the following phrase near the beginning of this page:

    Parameters must be quoted if they start with '' '' (space), " or contain ), ,.

    The problem is that the emphasizing by the font only is not enough readable; the better could be to list these characters explicitly:

    Parameters must be quoted if they start with '' '' (space), " (quote) or contain ) (closing parenthesis) or , (comma).

  • The table "Supported macro functions" contains function parameters in the angle brackets, but their descriptions without angle brackets (see the screenshot):

    It cause to impression that these brackets are a part of the format and also should be entered (but examples a bit later do not use them). It's needed some comment about their necessity. For example, the page about "usual" functions has this comment:

    Optional function parameters (or parameter parts) are indicated by < >

    However, the page about macro functions does not have any comments about angle brackets.
    Additionally, if they also mean "optional parameter" here, then it's needed to specify the default values if they are omitted.

The "Low-level discovery macros" page

The last paragraph in the "Overview" section has a broken link to the custom low-level discovery rules.
The correct link, probably, should be: (/manual/discovery/low_level_discovery/custom_rules).

Comment by Konstantīns Ošmjans [ 2023 Jul 27 ]

The "Configuring a user" page

The "Overview" section tells about "Admin" and "guest" predefined users; however, both links are broken: there is no "#user-type" section on that page.
Probably, it should be the "user-role" section.
The same page (about the "guest" user):

If you add it to the Guests user group, you may access monitoring pages in Zabbix without being logged in.

Probably, it was true for the older versions of Zabbix (for example, 5.0); but in v6.0 there is a role "Guest role", so it's unclear – which one should be used: user group or role?

The table "General attributes" contains the following phrase about the "Password" field:

With an existing password, contains a Password button, clicking on which opens the password fields.

Actually, this button is "Change password", not just "Password".

The "Permissions" page

The table in the "User role" section still has the heading "User type" (instead of "User role").

The "Scheduled reports" page

Table in the "Configuration" section contains for the "Subscriptions" field the exessive stars (it's enough a single star for a reference to notes):

Note that users with insufficient permissions***** will see Inaccessible user or Inaccessible user group ...

(that's all for this ticket, I won't add any additional issues here; if necessary, I'll open the new ticket)

Comment by Martins Valkovskis [ 2024 Feb 07 ]

Thank you for reporting, the issues in this ticket have been resolved.

Generated at Mon Jun 30 09:35:31 EEST 2025 using Jira 9.12.4#9120004-sha1:625303b708afdb767e17cb2838290c41888e9ff0.