Ad Widget

Collapse

Rebooting Zabbix manual

Collapse
X
 
  • Time
  • Show
Clear All
new posts
  • richlv
    Senior Member
    Zabbix Certified Trainer
    Zabbix Certified SpecialistZabbix Certified Professional
    • Oct 2005
    • 3112

    #16
    Originally posted by zalex_ua
    Requested to install additional plug-ins, they are useful to administer (for translators and others):
    http://www.dokuwiki.org/plugin:changes - very necessary!
    http://www.dokuwiki.org/plugin:usersubscriptions - very necessary!
    http://www.dokuwiki.org/plugin:comment - will be useful. Compatible with ODT Export.
    the first one should be installed now; second one can not be downloaded. i'm not sure about the 3rd, manual is sort of supposed to be descriptive and clear enough... let's wait that one for now
    Zabbix 3.0 Network Monitoring book

    Comment

    • nelsonab
      Senior Member
      Zabbix Certified SpecialistZabbix Certified Professional
      • Sep 2006
      • 1233

      #17
      Originally posted by richlv
      ...and one more question regarding the manual structure. where should faq section go ?

      my current idea is - an appendix that is linked to from the intro and troubleshooting sections (troubleshooting != faq)
      I say an FAQ should go near the front, and link to the sections. Although when I really think about it, it does not matter a whole lot other than preference. I do however think it's important that each answer link to the appropriate section by name (should someone print or convert to pdf or something) and hyperlink (should someone view it in the wiki).
      RHCE, author of zbxapi
      Ansible, the missing piece (Zabconf 2017): https://www.youtube.com/watch?v=R5T9NidjjDE
      Zabbix and SNMP on Linux (Zabconf 2015): https://www.youtube.com/watch?v=98PEHpLFVHM

      Comment

      • richlv
        Senior Member
        Zabbix Certified Trainer
        Zabbix Certified SpecialistZabbix Certified Professional
        • Oct 2005
        • 3112

        #18
        Originally posted by nelsonab
        I say an FAQ should go near the front, and link to the sections. Although when I really think about it, it does not matter a whole lot other than preference. I do however think it's important that each answer link to the appropriate section by name (should someone print or convert to pdf or something) and hyperlink (should someone view it in the wiki).
        the point of referencing both by link & name is a good one - i guess it will have to be added to general doc guidelines as well
        Zabbix 3.0 Network Monitoring book

        Comment

        • richlv
          Senior Member
          Zabbix Certified Trainer
          Zabbix Certified SpecialistZabbix Certified Professional
          • Oct 2005
          • 3112

          #19
          and here's the latest proposed outline
          Attached Files
          Zabbix 3.0 Network Monitoring book

          Comment

          • sj7trunks
            Junior Member
            • Oct 2009
            • 4

            #20
            Just a few notes:

            1) Dokuwiki, I've used this in 3 corporations all with success. I wrote a lot of css hacks for dokuwiki so this management style could be even better than it is now. Confluence works great in smaller environments but as more members use it, it gets to be a pain due to the backend DB requiring more resources.

            2) Management - I think management or a lead should help people get the things they need to write documentation. It's not just help but also assigning bugs, that'll be my next point. Questions get asked on the forum but no corresponding bug is filed. There is still a lot of features in Zabbix I have to explore with no knowledge that it exists.

            3) Bugs Bugs Bugs, We do it for developers then why not document writers? At least have a way to assign people work so they don't forget about it

            4) Speed and Uptime - I've already hit the server while it was down a few times... Latvia weather sucks. Documentation is usually needed right away, should we package this with the zabbix server package? Also pages seem somewhat slow sometimes, this seems to be a problem when trying to find something on forums or documentation. IRC seems to be the best method of information - Much apologies to richlv for always asking when I should go RTFM:P

            Comment

            • scoopex
              Junior Member
              • Sep 2010
              • 5

              #21
              Suggestions

              Hi,

              zabbix documentation lacks currently very often in many detail-depth aspects.
              Therefore it is really important to ease the creation of documentation.

              I think it would be a good idea:
              • examples,examples, examples: zabbix is really powerful monitoring system but users without good experiences in network-monitoring-systems need very much time to explore good strategies. Good examples can help to reduce the integration time dramatically.
              • to allow experienced zabbix users to enhance the documentation
              • to allow comments for existing documentation user for all wiki/forum users
              • to add a "report bug" button to every wiki page
              • a dump of the documentation should be included in the distribution
              • (i.e. in pdf format - thats useful for searching)

              Comment

              • zalex_ua
                Senior Member
                Zabbix Certified Trainer
                Zabbix Certified SpecialistZabbix Certified Professional
                • Oct 2009
                • 1286

                #22
                Proposition: a Discussion should be disabled everywhere at the folder level.
                For example in this place http://www.zabbix.com/documentation/1.8/manual.

                Comment

                • zalex_ua
                  Senior Member
                  Zabbix Certified Trainer
                  Zabbix Certified SpecialistZabbix Certified Professional
                  • Oct 2009
                  • 1286

                  #23
                  You forgot about this thread? let's goo

                  I think it makes sense to describe at this page http://www.zabbix.com/documentation/2.0/manual/concepts what is Template and what is Group.

                  I recall when i studied Zabbix first time i could not understand what the relationship between Templates and Groups (i mean template inheritance). I intuitively thought - need to include Template to the Group and Host to the same Group for the inheritance Items from Template to Host (my bad of course) . I spend some time to understand what is what (even after inspection documentation!). This stuff is not intuitively understandable by newbies. IMO

                  p.s. yes, i know, you remember about this thread because of damn bots .

                  Comment

                  Working...