discussion: restructure docs

[bendichter]

Right now we have a User Guide and a Developer Guide. I think we should restructure it in the following way:

• Getting Started
  • Creating a DANDI Account
  • DANDI Tools
• User Guide: Sharing Data
  • Creating a Dandiset
  • Converting Data to NWB
    • NWB GUIDE
    • NeuroConv
    • PyNWB and MatNWB
  • Validating NWB Files
  • Uploading Data
  • Dandiset Metadata
  • Publishing Dandisets
    • Data licenses
    • Citing your own Dandiset
  • Contributing the
• User Guide: Using Data
  • Exploring Dandisets
  • Accessing Data
    • Downloading
    • Streaming
    • External Services
  • Citing Dandisets
  • DANDI Hub

[satra]

sounds like a good plan. did you miss a dev guide section? (also with the restructure we should drop those integer prefixes.

[yarikoptic]

• I think we should either move Creating a DANDI Account from Getting Started or somehow otherwise making it crystal clear that it is not needed unless need to upload data, access embargoed data, or access the hub.
• I like that Data standards and Data Licenses are separate from specific Guides ATM since apply to both. May be should go under "Getting Started"? If people aren't allowed (licenses) and can't "talk" (standards) -- there is little point to start a conversation ;)
• What will we cover in DANDI tools? May be more of DANDI ecosystem to introduce not only CLI, webdav, hub, but also 3rd party integrations (all the services we integrate with) and related solutions (GUIDE, ...)?

[kabilar]

Thanks @bendichter.

did you miss a dev guide section?

+1

also with the restructure we should drop those integer prefixes.

+1

I think we should either move Creating a DANDI Account from Getting Started or somehow otherwise making it crystal clear that it is not needed unless need to upload data, access embargoed data, or access the hub.

In the Creating a DANDI Account page we note that an account is not needed for searching, viewing, and downloading open datasets. I would actually like to encourage everyone who interacts with DANDI to first create an account. This may make it easier for them to later use DANDI services where an account is required and may help us in better understanding utilization of the web application.

I like that Data standards and Data Licenses are separate from specific Guides ATM since apply to both. May be should go under "Getting Started"? If people aren't allowed (licenses) and can't "talk" (standards) -- there is little point to start a conversation ;)

If we don't move Data Licenses to 'Getting Started', then we should move it to Creating a Dandiset since selecting a license is required at this step.

What will we cover in DANDI tools? May be more of DANDI ecosystem to introduce not only CLI, webdav, hub, but also 3rd party integrations (all the services we integrate with) and related solutions (GUIDE, ...)?

+1

[kabilar]

Perhaps this restructure can happen more interactively/faster through use of a Google Doc? I have created a public Google Doc with @bendichter's outline above as a starting point.

[kabilar]

Related issue: https://github.com/dandi/handbook/issues/125

[kabilar]

Hi @bendichter, thanks for resolving all the comments on the Google Doc. It looks like we have settled on a new structure. If you have time, feel free to submit a pull request with the restructured docs.