Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,6 @@ To start using the archive, head over to the User Guide sections for [Sharing Da
If are a developer and want to know how the project is organized, check out the [DANDI Ecosystem](./getting-started/dandi-ecosystem.md)
page in the Getting Started section.


## Where to Get Help

You can communicate with the DANDI team in a variety of ways, depending on your needs:

- You can ask questions, report bugs, or
request features [at our helpdesk](https://github.com/dandi/helpdesk/issues/new/choose).
- For interacting with the global neuroscience community, post on https://neurostars.org
and use the tag [dandi](https://neurostars.org/tag/dandi).
- You can use the DANDI Slack workspace, which we will invite you to after approving your [registration on
DANDI using GitHub](https://dandiarchive.org/) (this registration is required to upload data or to use the DANDI
JupyterHub). See [here for details on how to
register](./getting-started/creating-account.md).
- Email us: [info@dandiarchive.org](mailto: info@dandiarchive.org)

## Contributing and Feedback

We are looking for people to give us feedback on this documentation. If anything
Expand Down
12 changes: 12 additions & 0 deletions docs/support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## Support

**For questions and support, we recommend using [GitHub Discussions](https://github.com/dandi/helpdesk/discussions/new?category=q-a)** 🙏

Additional support channels:

| Channel | Best For |
|---------|----------|
| ✨ [GitHub Issues](https://github.com/dandi/helpdesk/issues) | Report bugs and request features |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also have discussions which is more prominently used than issues. It is a bit unclear what should be an issue vs discussion, what about:

Suggested change
| [GitHub Issues](https://github.com/dandi/helpdesk/issues) | Report bugs and request features |
| 🤔 [GitHub Discussions](https://github.com/dandi/helpdesk/discussions) | Ask questions and propose/discuss potential new features |
|[GitHub Issues](https://github.com/dandi/helpdesk/issues) | Report bugs |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link to discussions is on the top but I agree that maybe we can expand on what should go to each section.

Perhaps here we can clarify that issues are for infrastructure, technical and software errors and in the top add a bullet point with the list of things are welcomed in the discussions:

  • I don't know how to do x.
  • Does dandi support format y?
  • I am getting an error when trying to upload my data.
  • I have questions about the dandi archive
  • Questions about embargo policy.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding examples could be helpful as long as there aren't "too many" per section. Above all I think we should strive to keep things minimal since the docs are already overwhelming to many users

We can always (and often do) transfer issues to their appropriate destinations without the user needing to worry about that, too (which can inhibit willingness to raise out of concern of not raising in the right place)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think 3 to 6 short bullet points as above can give a flavor of the type of questions that make sense for the help channel without being too many. The idea is to help the user orient themselves among the many available help channels. That is, to answer the question: where should I go with problem x.

I do agree that it can be overdone to the point of being intimidating rather than helpful. It is a fair point.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @h-mayorquin, @CodyCBakerPhD. I agree with Cody and would prefer to keep things minimal here, and we can transfer as needed.

Regarding Where should I go with problem x?, I would say that everything should go to GitHub Discussions. And we can triage from there. So the user does not have to make any decision and can just post their question.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense.

| 💬 [Slack](https://dandiarchive.slack.com/) | Interact with the DANDI community (available after [registration](./getting-started/creating-account.md)) |
| ✉️ [Email](mailto:help@dandiarchive.org) | Communicate privately |
| 🌟 [NeuroStars with the `dandi` tag](https://neurostars.org/tag/dandi) | Interact with the global neuroscience community |
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ nav:
- API:
- DANDI Client: "api/dandi-client.md"
- REST API: "api/rest-api.md"
- Support: "support.md"

# List of extensions
markdown_extensions:
Expand Down