You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: doc/neurosift_annotations.md
+4-5
Original file line number
Diff line number
Diff line change
@@ -15,23 +15,22 @@ easily with others. Possible names could be "annotations",
15
15
"neurosift-annotations", or "dandi-annotations". The same repo can be used to
16
16
hold annotations for multiple NWB files in multiple DANDIsets.
17
17
18
-
**Step 2: Install the neurosift-annotations GitHub app on your repository** (this is a one-time step)
18
+
**Step 2: Install the neurosift-annotations GitHub app for your GitHub account** (this is a one-time step)
19
19
20
20
Go to the [neurosift-annotations GitHub app](https://github.com/apps/neurosift-annotations) and click "Install".
21
21
Following the principle of least privilege, you should give access only to the repository where you want to store your annotations.
22
22
23
23
**Step 3: Authenticate with GitHub in Neurosift to give it access to your installed app**
24
24
25
-
In Neurosift, click on the key icon in the top right corner and click to log in
25
+
In [Neurosift](https://flatironinstitute.github.io/neurosift), click on the key icon in the top right corner and click to log in
26
26
to neurosift-annotations. This will allow Neurosift to access your GitHub
27
27
repository to store your annotations.
28
28
29
29
## Usage
30
30
31
31
Navigate to a DANDI NWB file in Neurosift. You will see a new "Annotations" tab.
32
32
Click on this tab to get more information about viewing and managing the
33
-
annotations for this file. Once you have set up neurosift-annotations and logged
34
-
in, you will be able to attach a top-level text note to the file or to any
33
+
annotations for this file. You will specify your repo there. Once you have set this up, you will be able to attach a top-level text note to the file or to any
35
34
neurodata object in the file.
36
35
37
36
## How annotations are stored in the repository
@@ -66,4 +65,4 @@ except this would of course be formatted as a single line in the file.
66
65
67
66
For now the only type of annotation is a "note", which is a piece of text that
68
67
can be attached to any neurodata object in the NWB file. In the future we plan
69
-
to support other types of annotations such as unit curations, etc.
68
+
to support other types of annotations such as unit curations, etc.
0 commit comments