Skip to content

Data Documentation -- discussion #84

@jennaj

Description

@jennaj

We need a unified strategy for data documentation.

Do we have to wait for the full IDC? What can we do near term?

Technical users.

  1. Describe the data hosted on CVMFS. Summary of datacache and how to review it
  2. Some automatic by detection but also reserved areas for administrative overrides -- manual and "also detect this /myserver/data/path".
  3. Auto-populated with logic (curation for logic, not content)
  4. More cross links to/from tutorials.

Scientific users: interpret the above, then make it human readable for non-technical people, and include actionable info to supplement what a tutorial or Help section abstracts. This server + this tool + this goal = decision matrix.

  1. Breadth of data for context ... and a notation system for what is available on this server.
  2. Layer in all the questions about reference data -- what the server has, what needs to be loaded, link to tutorials for the How-to (FAQs bundled into new "Olympics" types of tutorials).
  3. Importantly should include tool/parameter combinations you'll need to access a specific index.
    * Busco is an example -- https://help.galaxyproject.org/search?q=busco.
  4. Bookmarked guide! A tool form can link back into the guide via tool_id?

I'll work on this with whoever is interested!

Metadata

Metadata

Assignees

No one assigned

    Labels

    discussionLet's discuss and plan

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions