Uploaded image for project: 'ZABBIX BUGS AND ISSUES'
  1. ZABBIX BUGS AND ISSUES
  2. ZBX-21700

Inconsistent use of commas in documentation

XMLWordPrintable

    • Icon: Documentation task Documentation task
    • Resolution: Fixed
    • Icon: Trivial Trivial
    • 6.4 (plan)
    • 5.0.28, 6.0.9, 6.2.3, 6.4.0alpha1
    • Documentation (D)
    • None
    • Sprint 93 (Oct 2022)
    • 0.5

      In exactly the same places, sometimes commas are used and sometimes they are not used.
      For example, on master
      "Now" with comma:
      documentation/en$ grep -rI "Now," --include="*.md" .

      ./manual/quickstart/notification.md:Now, with delivering notifications configured it would be fun to
      ./manual/introduction/whatsnew640.md:Now, when Zabbix proxy, if it uses SQLite3, on startup detects that the existing database file version is older than
      ./manual/introduction/whatsnew640.md:Now, *heartbeat sender* is removed from a proxy, and therefore, Zabbix proxy *zabbix [process,heartbeat sender]* item is
      ./manual/appendix/install/okta.md:7\. Now, navigate to *Assignments* tab and press the "Assign" button,
      ./manual/appendix/install/locales.md:Now, run:
      ./manual/web_interface/frontend_sections/dashboards.md:Now, when saving the dashboard, you will notice that a new host
      ./manual/config/items/plugins.md:Now, these names may be used as connStrings in keys instead of URIs:
      ./manual/config/visualization/maps/links.md:a green line. Now, with the trigger in the problem state, your link may
      ./manual/config/notifications/media/webhook.md:    Redmine, ServiceNow, Slack, Zammad, and Zendesk webhooks provided by
      

      "Now" without comma:

      grep -rI "Now " --include="*.md" .
      ./manual/config/items/itemtypes/ipmi.md:IPMI checks by IPMI pollers. Now a host is always polled by only one
      ./manual/config/items/itemtypes/snmp.md:Now save the item and go to *Monitoring* → *Latest data* for your SNMP
      ./manual/config/visualization/maps/map.md:with a name, dimensions, and certain preferences. Now you need to add
      ./manual/config/visualization/maps/map.md:Now that you have some elements in place, you may want to start
      ./manual/config/triggers/dependencies.md:Click *Update*. Now the trigger has an indication of its dependency in
      ./manual/config/notifications/unsupported_item.md:And that's it, you're done! Now you can look forward to receiving your
      

      The same inconsistent use of commas is also detected for introductory words:

      Note,
      Note that,
      Also,
      For example,
      Finally,
      

      probably there are others.

      Documentation team must establish the policy on the use of commas and fix the inconsistencies in documentation.

            martins-v Martins Valkovskis
            arimdjonoks Artjoms Rimdjonoks
            Team D
            Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: