Provide template setup steps in documentation

XMLWordPrintable

    • Type: New Feature Request
    • Resolution: Fixed
    • Priority: Trivial
    • 5.0.5rc1, 5.2.0beta2, 5.2 (plan)
    • Affects Version/s: 5.0.1
    • Component/s: None
    • None
    • Sprint 65 (Jun 2020), Sprint 66 (Jul 2020), Sprint 67 (Aug 2020), Sprint 68 (Sep 2020), Sprint 69 (Oct 2020)
    • 1

      Due to common issues users encounter when setting up templates, we need to create page(s) with step-by-step instructions for the users, including:

      1) If the entity that is being monitored needs special setup -> provide brief description of what has to be changed + links to 3rd party entity documentation for details

      2) Macros setup: which macros should be specified to ensure proper template operation 

      3) Additional mandatory/optional steps. E.g. for agent 2 templates - providing credentials in the config file or using session variables. 

      Currently, it was decided to create such instructions for the following template groups: 

      • HTTP agent templates
      • Agent 2 templates
      • Templates for Windows

      Suggested format: common setup steps for the template group + a 3-column table to describe individual template specs: Template name | Macros setup | Additional steps/comments.

      Then, template descriptions on the Integrations page can focus on describing template features and link to this page in the documentation for setup instructions. 

       

            Assignee:
            Anton Fayantsev (Inactive)
            Reporter:
            Marina Generalova
            Team INT
            Votes:
            1 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved: