Skip to content

Documentation, tutorial(s) & entry in ODP registry #7428

@bvizzier-ucsc

Description

@bvizzier-ucsc

The next step in getting the AnVIL open access datasets into the AWS ODP is to provide the following information. The reference is Section 2 of the Onboarding Handbook for Data Providers document.

The information requested is (the following paragraphs are excerpts from the above document):

  • A document describing how the data is organized and how users can find the data they need
  • A tutorial on how to use the data on AWS. Tutorials differ from dataset documentation, in that tutorials illustrate some end-to-end usage of the data on AWS in a “how to” format. Beyond a factual description of the dataset, tutorial content should guide the reader through some interesting use of the dataset.
  • An entry on the Registry of Open Data 9. The Registry is a mechanism for users of your dataset to learn about the data, learn how to access the data, and find documentation, tutorials, usage examples, and publications that demonstrate using your dataset.
  • Please also send a copy of your logo to be used on the dataset landing page to [email protected].
    This logo is displayed at a width of 160px, so something larger than that will be required.

Creating an entry on the Registry of Open Data for your dataset requires creating a structured (YAML-formatted) text file that contains information about your dataset. You can then submit that YAML via a draft pull request on our Github project.

The Registry’s project and documentation for the format of the YAML file can be found at the
Registry of Open Data’s Github site.

Metadata

Metadata

Assignees

Labels

-[priority] Mediummirror[subject] Code and infrastructure for mirroring data files

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions