From 77adfa95dfcf3586f95341f7ddb1d4830aa1ae02 Mon Sep 17 00:00:00 2001
From: Vitor Trovisco <vmt25@cam.ac.uk>
Date: Thu, 4 Aug 2022 10:23:54 +0000
Subject: [PATCH] improved commenting
---
canto/canto_deploy.yaml | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/canto/canto_deploy.yaml b/canto/canto_deploy.yaml
index 7c33833..7189a83 100644
--- a/canto/canto_deploy.yaml
+++ b/canto/canto_deploy.yaml
@@ -16,17 +16,17 @@ annotation_figure_field: 0
show_quick_deletion_buttons: 0
# this will define Canto's internal SQL database (track.sqlite3 and files for all curation sessions) to the the 'data' sub-folder of 'canto-space' (<filepath>/canto-space/data), which is where all data should reside.
-# Here filepaths are relative. Have an initial '/' in '/data/track.sqlite3' and '/data' below, otherwise track.sqlite3 and the data will appear in '<filepath>/canto-space/canto/data' rather than in '<filepath>/canto-space/data'.
+# Here, filepaths are somewhat relative. Please have an initial '/' in both '/data/track.sqlite3' and '/data' below, otherwise track.sqlite3 and the curation data will be added to a new 'data' folder at '<filepath>/canto-space/canto/data', rather than to the existing 'data' sub-folder of 'canto-space' at '<filepath>/canto-space/data'.
Model::TrackModel:
connect_info:
-# this sets the path (and name) of the sqlite3 file (track.sqlite3), which queries curation sessions within canto
-# make sure it does include the initial '/', otherwise curation session will be misplaced in '<filepath>/canto-space/canto/data'
-# Make sure the folder where the SQL database 'track.sqlite3' lives (/data in /data/track.sqlite3) matches the data_directory value (/data)
+# this sets the path (and name) of the sqlite3 file 'track.sqlite3', which queries curation sessions within canto
+# as mentioned above, make sure it does include the initial '/', otherwise 'track.sqlite3' will be misplaced in a new 'data' folder at '<filepath>/canto-space/canto/data'
+## Make sure the folder where the SQL database 'track.sqlite3' lives (/data in /data/track.sqlite3) matches the data_directory value mentioned below (/data)
- dbi:SQLite:dbname=/data/track.sqlite3
schema_class: Canto::TrackDB
# this sets the path to the 'data' sub-folder of 'canto-space', which is where all curation data should reside.
-# make sure it does include the initial '/', otherwise curation session will be misplaced in '<filepath>/canto-space/canto/data'
-# and make sure the folder where the SQL database 'track.sqlite3' lives (/data/track.sqlite3) matches the data_directory value (/data)
+# as mentioned above, make sure it does include the initial '/', otherwise curation session will be misplaced in a new folder '<filepath>/canto-space/canto/data' rather than in the existing 'data' sub-folder of 'canto-space'
+## Make sure the folder where the SQL database 'track.sqlite3' lives (/data/track.sqlite3) matches this data_directory value (/data)
data_directory: /data
#Database to connect to - 'connect_info:' bit is the only part that needs changes on a weekly basis
--
GitLab