From 440b96b9a560db167fddc78a8db97c0372de005c Mon Sep 17 00:00:00 2001 From: Sherilyn Moline Date: Thu, 10 Oct 2019 11:03:20 -0400 Subject: [PATCH 1/3] adding a link to the notes folder to README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 374fc9cc..59be64e5 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Please check out https://www.voicesofconsent.org/what-we-do as well as the rest See our CONTRIBUTING.md # Background -We've started a few reference documents based on questions we've been asked. Check out the /notes folder in the repo, and please ask questions in the Ruby for Good Slack or on Github so we can improve our references. +We've started a few reference documents based on questions we've been asked. Check out the https://github.com/rubyforgood/voices-of-consent/tree/develop/notes folder in the repo, and please ask questions in the Ruby for Good Slack or on Github so we can improve our references. # Setting Up Development From 25d01762aa6473b4913acf254b2ef3421c27da2b Mon Sep 17 00:00:00 2001 From: Sherilyn Moline Date: Thu, 10 Oct 2019 11:07:19 -0400 Subject: [PATCH 2/3] made /notes link relative --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 59be64e5..b5ac5760 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Please check out https://www.voicesofconsent.org/what-we-do as well as the rest See our CONTRIBUTING.md # Background -We've started a few reference documents based on questions we've been asked. Check out the https://github.com/rubyforgood/voices-of-consent/tree/develop/notes folder in the repo, and please ask questions in the Ruby for Good Slack or on Github so we can improve our references. +We've started a few reference documents based on questions we've been asked. Check out the [/notes](notes) folder in the repo, and please ask questions in the Ruby for Good Slack or on Github so we can improve our references. # Setting Up Development From a82fdb68418f3140919710fd862c84848c5a1c29 Mon Sep 17 00:00:00 2001 From: Sherilyn Moline Date: Thu, 10 Oct 2019 11:36:13 -0400 Subject: [PATCH 3/3] links to database-diagram as well as how to edit it --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b5ac5760..e3564150 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,13 @@ Please check out https://www.voicesofconsent.org/what-we-do as well as the rest See our CONTRIBUTING.md # Background -We've started a few reference documents based on questions we've been asked. Check out the [/notes](notes) folder in the repo, and please ask questions in the Ruby for Good Slack or on Github so we can improve our references. +We've started a few reference documents based on questions we've been asked. Make sure you also read our [background.md](notes/background.md), and check out the [database-diagram.png](notes/database-diagram.png) all of which is located in the [/notes](notes) folder in the repo. + +Also located in the [/notes](notes) folder is [database-diagram.dot](notes/database-diagram.dot) which is used to create the [database diagram.png](notes/database-diagram.png). If you want to edit this file and generate new versions of the [database-diagram.png](notes/database-diagram.png), visit http://graphviz.it/ and paste the code from your [database-diagram.dot](notes/database-diagram.dot). Make sure you erase all the code on this website and replace it with the entire contents of your .dot file to see your diagram properly. + +If you want to know more about how to update the [database-diagram.png](notes/database-diagram.png), please checkout Casey Watts' instructional post on graphviz at https://gist.github.com/caseywatts/be69bf941fa1f8e264bd07de698366a0. + +If you have any questions please feel free to reach out in the Ruby for Good Slack or on Github so we can improve our references. # Setting Up Development