add documentation steps for starting a new data collection

CDRH · Mar 1, 2023 · 3f78ce0 · 3f78ce0
1 parent d4a8144
commit 3f78ce0
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 6 deletions.
diff --git a/docs/1_setup/collection_setup.md b/docs/1_setup/collection_setup.md
@@ -2,7 +2,11 @@
 
 ### Step 1:  Create a new collection directory
 
-Install datura, then run:
+Install datura by creating a new directory with a `Gemfile` with
+`gem "datura", git: 'https://github.com/CDRH/datura', branch: "dev"` 
+Make a file `.ruby-version` with the ruby version required by Datura (currently 3.1.2).
+Run `bundle install` and make sure Datura install successfulle.
+Then run:
 
 ```
 setup

diff --git a/docs/1_setup/config.md b/docs/1_setup/config.md
@@ -7,12 +7,13 @@ Open up the `config/public.yml` file in your new collection and add or change th
 ```yaml
 default:
   collection:
-  es_index
-  es_path
-  es_user
-  es_password
+  es_index:
+  es_path:
+  es_user:
+  es_password:
+  api_version:
 ```
-(The options es_user and es_password are needed if you are using a secured Elasticsearch index.)
+(The options es_user and es_password are needed if you are using a secured Elasticsearch index.) api_version is required with the new API schema, please specify "2.0", or "1.0" if using with a legacy repository that uses the old fields.
 
 If there are any settings which must be different based on the local environment (your computer vs the server), place these in `config/private.yml`.