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

Add required README.txt to /datasets/refcats/htm

    XMLWordPrintable

    Details

    • Story Points:
      1
    • Epic Link:
    • Sprint:
      AP F19-6 (November)
    • Team:
      Alert Production

      Description

      The developer guide "Responsibilities" section notes that datasets need a readme, and has a specific note about where the refcat readme goes. We have no such readme for any of the /datasets/refcats subdirectories. I'll writeup a description of the Gaia DR2 data and attempt to add some description of the other existing htm/v1 refcats.

        Attachments

          Issue Links

            Activity

            Hide
            Parejkoj John Parejko added a comment -

            My concern with putting a README in the catalog directory is that doing "ls" in that directory is a bad idea (~100k files), so it's not really findable. For example, I had no idea there even was a README in the ps1 refcat! If we mention that the subdirectories have a readme in the top-level one, that will mitigate this somewhat. Another question is what happens with the gen3 refcats, which I believe are just a database: where would the README files for those go?

            How do I determine who is responsible for a refcat's maintenance? Why would that be different from the person who generated the catalog?

            Show
            Parejkoj John Parejko added a comment - My concern with putting a README in the catalog directory is that doing "ls" in that directory is a bad idea (~100k files), so it's not really findable. For example, I had no idea there even was a README in the ps1 refcat! If we mention that the subdirectories have a readme in the top-level one, that will mitigate this somewhat. Another question is what happens with the gen3 refcats, which I believe are just a database: where would the README files for those go? How do I determine who is responsible for a refcat's maintenance? Why would that be different from the person who generated the catalog?
            Hide
            Parejkoj John Parejko added a comment -

            Paul Price: I've updated the htm readme and added a gaia-specific readme. Please have another look.

            Show
            Parejkoj John Parejko added a comment - Paul Price : I've updated the htm readme and added a gaia-specific readme. Please have another look.
            Hide
            krughoff Simon Krughoff added a comment -

            I agree that putting the README exclusively in the directory with the shards will make it impossible to find. What if we put it in with the shards, but require a symlink one level up?

            Show
            krughoff Simon Krughoff added a comment - I agree that putting the README exclusively in the directory with the shards will make it impossible to find. What if we put it in with the shards, but require a symlink one level up?
            Hide
            price Paul Price added a comment -

            Looks good, thanks.

            Show
            price Paul Price added a comment - Looks good, thanks.
            Hide
            Parejkoj John Parejko added a comment -

            Thank you for the suggestions: I've fixed the dev guide, and will prepare a Community post announcing the new refcat and the READMEs.

            Show
            Parejkoj John Parejko added a comment - Thank you for the suggestions: I've fixed the dev guide, and will prepare a Community post announcing the new refcat and the READMEs.

              People

              Assignee:
              Parejkoj John Parejko
              Reporter:
              Parejkoj John Parejko
              Reviewers:
              Paul Price
              Watchers:
              Hsin-Fang Chiang, John Parejko, John Swinbank, Kian-Tat Lim, Paul Price, Simon Krughoff
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: