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

Document the example listener in Observation module

    XMLWordPrintable

Details

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

    Description

      In the Observation module document, explain the following points:

      • Observation module is NOT installed by default. The current text is incorrect.
      • Make it clear that even though the /modules/observation folder is present in a typical bundle installation it doesn't mean the Observation module is actually installed. Common stumbling block. How to check if a module is installed?
      • Some other modules bootstrap their own listener configurations which causes the /modules/observation folder to be created. Explain what modules included in the EE bundle do this and describe the listeners they bootstrap. Verify that the modules' own articles also mention the listeners.
      • Install the Observation module and describe the example listener it bootstraps. It's a commonly requested listener, search the mailing list. Explain how to customize it for example to listen to the dms workspace.
      • Link to the Commands chapter in Technical Guide from relevant places because it is more common to specify a command to be executed than it is to write your own event listener.
      • Did anyone write their own event listener? Search the mailing list. What problems did they solve?

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

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

              Dates

                Created:
                Updated:

                Checklists

                  Task DoR