Uploaded image for project: 'Opencast'
  1. MH-9509

As a Matterhorn System Administrator I need to be able to consult the technical meaning of each configuration key from a central location

    Details

    • Type: Story Card
    • Status: Open
    • Resolution: Unresolved
    • Affects versions: None
    • Fix versions: None
    • Components: Documentation
    • Labels:

      Description

      Currently keys in configuration files (e.g. config.properties) have some limited amount of comments explaining them. There is no central location on the opencast wiki where a Matterhorn System Administrator could find detailed technical information about each key.
      The problem with such limited information can be seen in the org.opencastproject.workspace.rootdir key from the config.properties which is explained with this single too limited sentence : "The path to the working files (recommend using fast, transient storage)"

      Ideally each configuration file would have a dedicated page where each key is explained, with subpages when there are more than N keys to document. Each configuration file would reference in its comments its documentation page on the wiki. Also each key documentation would contain references to other pages that are documenting Matterhorn at higher level but that relates to the key. For instance in the wiki page about config.properties, the org.opencastproject.workspace.rootdir key would have its own subpage with a technical definition and with links to http://opencast.jira.com/wiki/display/MHDOC/Storage+Architecture+and+Best+Practices+For+Distributed+Environments

        TestRail: Results

          Attachments

            Issue links

              Activity

                People

                • Assignee:
                  Unassigned
                  Reporter:
                  jaimeg Jaime Gago
                • Watchers:
                  1 Start watching this issue

                  Dates

                  • Created:
                    Updated:

                    TestRail: Cases