Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-23089

Add title/description fields to configuration files

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Won't Fix
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: ts_middleware
    • Labels:
      None
    • Team:
      Telescope and Site

      Description

      Add description and title fields to configuration schemas. This will allow a field where the person making the configuration change can explain when and why the changes were made. Then, instead of being buried in the file, it gets posted to the EFD such that it is easier to find.

      Ideally, the description field would be forced to be filled out, analogous to a commit message.

        Attachments

          Issue Links

            Activity

            Hide
            tribeiro Tiago Ribeiro added a comment -

            I would also suggest we add fields to the `settingsApplied` event to output the description and title that goes in the configuration title. 

             

            Michael Reuter?

            Show
            tribeiro Tiago Ribeiro added a comment - I would also suggest we add fields to the `settingsApplied` event to output the description and title that goes in the configuration title.    Michael Reuter ?
            Hide
            rowen Russell Owen added a comment - - edited

            I agree it would be nice to have some means of identifying why a configuration file exists. I am less convinced that a title is useful; I would rather use the name of the file as the title. It is more likely to be correct and avoids duplicating information.

            Enforcing the presence of a description field is tricky because every CSC's configuration schema is independent of every other. One possibility is to have a unit test that tests all config files against the schema. I think this is a good idea in any case, as otherwise we may have broken config files that only show up when we try to use them. Such a test could demand the presence of a non-empty description field.

            Note: it will probably be common to create a new config file by copying and modifying an existing file. If the user forgets to change the description it will be wrong. Incorrect information can be worse than no information. However, the unit test I just mentioned could check that the description field is different for each file.

            Show
            rowen Russell Owen added a comment - - edited I agree it would be nice to have some means of identifying why a configuration file exists. I am less convinced that a title is useful; I would rather use the name of the file as the title. It is more likely to be correct and avoids duplicating information. Enforcing the presence of a description field is tricky because every CSC's configuration schema is independent of every other. One possibility is to have a unit test that tests all config files against the schema. I think this is a good idea in any case, as otherwise we may have broken config files that only show up when we try to use them. Such a test could demand the presence of a non-empty description field. Note: it will probably be common to create a new config file by copying and modifying an existing file. If the user forgets to change the description it will be wrong. Incorrect information can be worse than no information. However, the unit test I just mentioned could check that the description field is different for each file.
            Hide
            rowen Russell Owen added a comment -

            We have agreed to support a metadata item in configuration files and will put this information there.

            In DM-29621 I have updated ts_salobj to ignore the metadata entry. In other tickets that we run in the ts_config packages we will test for the presence of metadata. (The code for those tests may well end up in ts_salobj, but not on either of these tickets).

            Show
            rowen Russell Owen added a comment - We have agreed to support a metadata item in configuration files and will put this information there. In DM-29621 I have updated ts_salobj to ignore the metadata entry. In other tickets that we run in the ts_config packages we will test for the presence of metadata. (The code for those tests may well end up in ts_salobj, but not on either of these tickets).

              People

              Assignee:
              rowen Russell Owen
              Reporter:
              pingraham Patrick Ingraham
              Watchers:
              Andy Clements, Michael Reuter, Patrick Ingraham, Russell Owen, Tiago Ribeiro, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.