2.2 Descriptive documentation (REPLACE BEFORE PUBLIC RELEASE)

This documentation describes how the data is organized and how users can find the data they need. This documentation, for example, is where you would include a data dictionary and description of any formal schema applied to your data. Examples of this kind of documentation include Amazon Berkeley Objects,8 Speedtest by Ookla,9 Southern California Earthquake Data Center,10 and Global Biodiversity Information Facility.11 You may host this descriptive documentation where you choose (such as at your institution’s website). If you do not have an official website to host this documentation, we strongly recommend creating this documentation in Github, together with the tutorial notebook described in the next section. This documentation’s URL should be added to your dataset’s metadata in the “Documentation” field of the YAML document you started in the previous section.