Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCU-168

Support procedures

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • Neutral
    • None
    • None
    • content
    • None

    Description

      Document tasks that Support commonly asks clients to do:

      • Exporting configuration
      • Configuring a debug log
      • Debugging a particular class. (How to know which class to debug? Erroring class name is usually in the error log.)
      • Where does the log write?
      • How to copy a log file to a service like pastebin.com and send a link

      If Support asks to "turn on your debug log and send it", these procedures should tell you how to do exactly that.

      Publish the documents under the Support section on documentation site. They need to be standardized and publicly available so Support can point users to them systematically.

      Resources and existing material:

      • Support page on wiki has some procedures the. See child pages titled "Tracking..." Make them official.
      • Mail module article has a good procedure for error logging. Don't reinvent the wheel. Adapt procedure to debug logging.
      • Running Magnolia explains how to start Magnolia so that startup log is displayed in the terminal.
      • Audit trail

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              ahietala Antti Hietala
              ahietala Antti Hietala
              Votes:
              1 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:

                Checklists

                  Task DoR