Skip to content

Create documentation area for dataset #601

@SeanDuHare

Description

@SeanDuHare

Description

  • Design (maybe research via looking at Quilt?)
  • We want to mirror the features that Quilt provides that our internal users like, at least to a degree, and the main thing remaining we have been told is the ability to render documentation about the dataset (a README). It is unclear to me if just one would be enough or if multiple would be needed. We would need a design for optionally incorporating a README into the app area of the website.

Detail what you already know and/or your best guesses. UX will help fill in blanks once assigned.

Size

Small

Scope

Research Quilt & what users need documentation wise from quilt (1 page or > 1 page or maybe even 0 pages after all). Design where users would find the documentation (does it auto-load at first, is there a prompt, is it just available via a click, how high priority is the button to view it). Data leads for previous Quilt releases would be good contacts (Antoine, Julie D., Matheus?, Nathalie)

User needs statement(s)

As a viewer I want to be able to see a description of a dataset that is published.
A a researcher I want to be able to provide context around a dataset that is published.

Additional notes

Currently we provide a description on the Open source datasets page, but this ticket is about moving that feature/ability more into the app so that anyone could provide a description (without having to publish onto our open source dataset page).

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions