From a59aca8ceadc57713ff41d99ff7aaa8d79a4b5a3 Mon Sep 17 00:00:00 2001
From: Mathieu Guay-Paquet <mathieu.guay-paquet@polymtl.ca>
Date: Tue, 11 Jun 2024 14:58:31 -0400
Subject: [PATCH] Add a first little bit of dataset admin guide

---
 data/README.md      | 11 ++++++++++-
 data/admin-guide.md | 29 +++++++++++++++++++++++++++++
 2 files changed, 39 insertions(+), 1 deletion(-)
 create mode 100644 data/admin-guide.md

diff --git a/data/README.md b/data/README.md
index 178c5d36..8d4de5e2 100644
--- a/data/README.md
+++ b/data/README.md
@@ -1,10 +1,19 @@
 # <span>💾</span> Data
 
+For the details of how we structure datasets at the lab, see:
+
 ```{toctree}
 :maxdepth: 1
 dataset-curation
 ```
 
+For instructions on how to do various admin tasks on our data server, see:
+
+```{toctree}
+:maxdepth: 1
+admin-guide
+```
+
 MRI, microscopy and other research data are stored in the following servers:
 
 ```{toctree}
@@ -14,4 +23,4 @@ duke
 django
 ```
 
-[Here](https://docs.google.com/spreadsheets/d/1yjcA8Z0COn4OZxusIDHjStH2DpeXvscsj-aWE2X-_sg) useful list of MRI data to use for various projects. 
+[Here](https://docs.google.com/spreadsheets/d/1yjcA8Z0COn4OZxusIDHjStH2DpeXvscsj-aWE2X-_sg) is a useful list of MRI data to use for various projects.
diff --git a/data/admin-guide.md b/data/admin-guide.md
new file mode 100644
index 00000000..54202a27
--- /dev/null
+++ b/data/admin-guide.md
@@ -0,0 +1,29 @@
+# Dataset admin guide
+
+TODO: list the places where we have datasets (data.neuro.polymtl.ca, github, aws, compute canada, spineimage.ca)
+
+TODO: describe our current access rules
+
+TODO: give some API examples/scripts
+
+See also: [the user guide](git-datasets.md)
+
+## New repository
+
+We have a [dataset template](https://data.neuro.polymtl.ca/datasets/template) that we use for new repositories. When someone at the lab asks for a new dataset on <https://data.neuro.polymtl.ca/>, the steps to take are:
+
+1. Make sure they've opened [an issue in data-management](https://github.com/neuropoly/data-management/issues) with the name they want. Note that we only use **lowercase letters** and **hyphens** (no underscores).
+2. Log in to Neurogitea and go to [the repository creation page](https://data.neuro.polymtl.ca/repo/create?org=2). Then:
+   1. Select the organization "NeuroPoly datasets" as owner.
+   2. Fill in the repository name.
+   3. "Make Repository Private" should already be checked.
+   4. Select "datasets/template" as the template.
+   5. For template items, check the box for "Git Content (Default Branch)".
+   6. Click "Create Repository".
+3. In the new repository, click "Watch" so that at least one admin gets notifications (that is, you).
+4. Give write access to the requesting student:
+   1. Go to the repository's "Settings" tab.
+   2. Select "Collaborators" from the left-hand menu.
+   3. Search for the student's name and click "Add Collaborator".
+   4. Make sure the student's Neurogitea user account contains their actual human-readable name ("Site Administration" -> "User Accounts" -> search for the user -> edit).
+5. Reply on the original [data-management issue](https://github.com/neuropoly/data-management/issues) that you've created the repo and given them write access, with a link to the repo.