Uploaded image for project: 'Modules'
  1. Modules
  2. MODULES-3072

Not all supported modules have good configuration examples (examples directory)

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: supported
    • Labels:
    • Template:
    • Team:
      Modules
    • Story Points:
      1
    • Sprint:
      Modules - Product Backlog
    • CS Priority:
      Normal
    • CS Frequency:
      5 - >90% of Customers
    • CS Severity:
      1 - Superficial
    • CS Business Value:
      3 - $$$$
    • CS Impact:
      Hide
      The examples directory is mentioned in the style guide and also our trainings. Most supported modules are well documented with examples in the readme but do not contain an examples directory. They probably should to ensure that we are fully adhering to our style guide.

      Customers who do notice this sort of thing generally make a snarky or amused comment but it's not a major complaint.
      Show
      The examples directory is mentioned in the style guide and also our trainings. Most supported modules are well documented with examples in the readme but do not contain an examples directory. They probably should to ensure that we are fully adhering to our style guide. Customers who do notice this sort of thing generally make a snarky or amused comment but it's not a major complaint.

      Description

      When speaking with support / FSEs it was noted that not all supported modules have good examples to follow. If there were better examples it would reduce the amount of questions being fielded by support, it would also encourage best practice.

      This ticket is to asses the current supported modules and list the modules that need examples / demo manifests.

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            tp Thomas Honey
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Zendesk Support