Skip to content

Commit d12d212

Browse files
Merge branch 'master' into copilot/add-context-menu-to-section
2 parents 8e0cdeb + 97024b0 commit d12d212

13 files changed

Lines changed: 79 additions & 20 deletions

File tree

docs/img/dandi_api_key_reset.png

11.7 KB
Loading

docs/index.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,6 @@ To start using the archive, head over to the User Guide sections for [Sharing Da
1818
If are a developer and want to know how the project is organized, check out the [DANDI Ecosystem](./getting-started/dandi-ecosystem.md)
1919
page in the Getting Started section.
2020

21-
22-
## Where to Get Help
23-
24-
You can communicate with the DANDI team in a variety of ways, depending on your needs:
25-
26-
- You can ask questions, report bugs, or
27-
request features [at our helpdesk](https://github.com/dandi/helpdesk/issues/new/choose).
28-
- For interacting with the global neuroscience community, post on https://neurostars.org
29-
and use the tag [dandi](https://neurostars.org/tag/dandi).
30-
- You can use the DANDI Slack workspace, which we will invite you to after approving your [registration on
31-
DANDI using GitHub](https://dandiarchive.org/) (this registration is required to upload data or to use the DANDI
32-
JupyterHub). See [here for details on how to
33-
register](./getting-started/creating-account.md).
34-
- Email us: [info@dandiarchive.org](mailto: info@dandiarchive.org)
35-
3621
## Contributing and Feedback
3722

3823
We are looking for people to give us feedback on this documentation. If anything

docs/support.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Support
2+
3+
**For questions and support, we recommend using [GitHub Discussions](https://github.com/dandi/helpdesk/discussions/new?category=q-a)** 🙏
4+
5+
Additional support channels:
6+
7+
| Channel | Best For |
8+
|---------|----------|
9+
|[GitHub Issues](https://github.com/dandi/helpdesk/issues) | Report bugs and request features |
10+
| 💬 [Slack](https://dandiarchive.slack.com/) | Interact with the DANDI community (available after [registration](./getting-started/creating-account.md)) |
11+
| ✉️ [Email](mailto:help@dandiarchive.org) | Communicate privately |
12+
| 🌟 [NeuroStars with the `dandi` tag](https://neurostars.org/tag/dandi) | Interact with the global neuroscience community |

docs/terms-policies/policies.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# General Policies v1.1.0
1+
# General Policies v1.2.0
22

33
## Content
44

@@ -47,6 +47,16 @@
4747
share access with other collaborators. These files will not be made publicly
4848
available till the end of the embargo period.
4949

50+
## Collected Information
51+
52+
We and our service providers collect a variety of information through the sites and by other means, which may include:
53+
54+
- **Information you submit**: When you contact us, we collect information when you send us an email or send information to our servers. This may include your name, email address, the content of your communication, and any data you upload in association with the DANDI project. This does not include the research data, which is subject to any applicable research consent and applicable provisions of the Terms and Conditions.
55+
- **Information collected automatically**: We or our third-party service providers may automatically receive and record certain information when you use our Sites. For example, this may include your device's IP address, information about your use of the sites during your current session and over time (including the pages you view and your interactions with them, as well as what information you download), the date and time of your visit, links you click, searches conducted, the website visited before navigating to the website, social media referrals used to find the website (such as Facebook and LinkedIn), your software and hardware attributes (including browser and operating system type and version), and your general location inferred from IP address. To obtain such information, we or our third-party service providers may use the following technologies to recognize your device and collect information about your usage of the sites:
56+
- _Server logs_: When you use the website, we automatically receive and record certain information from your computer (or other device) and your browser. To obtain such information, we may use server logs or applications that recognize your device and gather information about its online activity.
57+
58+
We may combine information collected through the Sites with information that we collect in other contexts, such as information from email communications with you. We will treat such combined information in accordance with this General Policy.
59+
5060
## Removal
5161

5262
- **Revocation:** Content not considered to fall under the scope of the repository

docs/user-guide-sharing/converting-data/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Most of the data on DANDI is in Neurodata Without Borders (NWB), a data standard
66
See [Converting data to NWB](./nwb/index.md) for guidance in how to convert your data to NWB and publish on DANDI.
77

88
DANDI also supports the [Brain Imaging Data Structure (BIDS)](https://bids.neuroimaging.io/). For more information, see:
9+
910
- [Getting Started with BIDS](https://bids.neuroimaging.io/getting_started/index.html)
1011
- [BIDS converters](https://bids.neuroimaging.io/tools/converters.html) for conversion of raw data to a BIDS dataset
1112
- [BIDS specification](https://bids-specification.readthedocs.io)

docs/user-guide-sharing/dandiset-metadata.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ Make sure to inspect the metadata for each institution on the ror.org website, a
4646
(e.g. many different countries have an "NIH"). Make sure to select the role `dcite:Funder` to list the contributor
4747
under the "Funding information" section.
4848

49+
If there is more than one award number associated with a funding agency, you should enter the organization multiple times,
50+
once for each award number.
51+
4952
### Subject Matter
5053

5154
The Subject Matter section allows you to annotate the Dandiset with links to terms in ontologies. Use `Generic Type`
@@ -66,3 +69,17 @@ It is highly recommended to add links to the following resources (if they exist)
6669
* A data analysis library associated with the publication that can take this data as input
6770
* An example notebook submitted to http://github.com/dandi/example-notebooks that demonstrates how to use the data
6871
* Associated datasets published on DANDI or on other archives.
72+
73+
#### Related Resource Relation
74+
75+
Related Resources include a relation attribute.
76+
The relation tag describes the relationship FROM the Dandiset TO the resource.
77+
In other words, this relation should satisfy: dandiset `<relation>` resource.
78+
79+
If the resource is a journal article or preprint, the "repository" should be the name of the journal or preprint server.
80+
81+
Some common relations include:
82+
83+
* For a publication or preprint that is the primary account of the data being deposited, use "dcite:isDescribedBy".
84+
* For a data descriptor paper, e.g. as is common in the journal Scientific Data, use "dcite:IsDocumentedBy".
85+
* To associate a new paper that analyzes the data in this Dandiset, use "dcite:IsCitedBy".

docs/user-guide-sharing/publishing-dandisets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Once you create a Dandiset, DANDI will automatically create a `draft` version
44
of the Dandiset that can be changed as many times as needed by editing the
55
metadata or uploading new files.
66

7-
When the draft version is ready, you can *publish* your Dandiset. This results
7+
When the draft version is ready, you should *publish* your Dandiset. This results
88
in an immutable snapshot of your Dandiset with its own unique version number
99
that others can cite. If you need to change the data or metadata, you can do
1010
so by continuing to modify the draft version and publishing a new version

docs/user-guide-sharing/uploading-data.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,13 @@ There are two options for storing your DANDI access credentials:
7171

7272
- Note that there are no spaces around the "=".
7373

74+
- If your `DANDI_API_KEY` needs to be reset (for example, because it was publicly exposed), you can cycle your API key by following the instructions below:
75+
76+
1. Log in to DANDI Archive
77+
2. Click on your user initials in the top-right corner
78+
3. Click the circular arrow
79+
![dandi_api_key_reset](../img/dandi_api_key_reset.png)
80+
7481
### 2. `keyring` Library
7582

7683
If the `DANDI_API_KEY` environment variable is not set, the CLI will look up the API key using the [keyring](https://github.com/jaraco/keyring) library, which supports numerous backends, including the system keyring, an encrypted keyfile, and a plaintext (unencrypted) keyfile.

docs/user-guide-sharing/validating-files.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,8 @@ Passing all of these levels of validation can sometimes be tricky. If you have a
4545

4646
## Validating BIDS Files
4747

48-
Once your files are converted to the BIDS standard, perform validation of the files using the [BIDS validator](https://bids.neuroimaging.io/tools/validator.html).
48+
Once your files are converted to the BIDS standard,
49+
50+
- ensure that you have a [`dataset_description.json`](https://bids-specification.readthedocs.io/en/stable/modality-agnostic-files/dataset-description.html#dataset_descriptionjson) file at the top-level of your dataset directory;
51+
- ensure that you have a `.bidsignore` file containing `dandiset.yaml`, since that DANDI-specific file is not part of the BIDS specification;
52+
- perform validation of the files using [`dandi validate`](https://dandi.readthedocs.io/en/latest/cmdline/validate.html) to ensure your data is compliant with the BIDS and/or NWB standards. Alternatively, you could independently validate your files using the [BIDS Validator](https://bids.neuroimaging.io/tools/validator.html) and/or [NWB Inspector](https://nwb.org/tools/core/nwbinspector/). Note that [`dandi upload`](https://dandi.readthedocs.io/en/latest/cmdline/upload.html) will also perform validation during upload.

0 commit comments

Comments
 (0)