Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Documentation
-
Labels:
-
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.
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?