docs

diff --git a/README.md b/README.md
index 323b8788eafb13ffb4edecc43ae9fc8e9f981e54..24c3d666f911899fd1aa92d64e377f3201194e8d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -43,6 +43,38 @@ NOTE: There are currently 2 monitors set up:
 NOTE: We still have an ongoing issue with the EPL server hanging up.  This is being worked on.
 
 
+# Database
+
+The database is MongoDB.
+MongoDB is not a relational database, but rather a noSQL or "document/object" based database.
+Data is stored as structured objects versus tables and rows.
+(More about MongoDB)[http://mongodb.org].
+
+## Collections
+
+- archivedcourses
+       [[ schema needed ]]
+- archivednotes
+       [[ schema needed ]]
+- archivedsubjects
+       [[ schema needed ]]
+- courses
+       [[ schema needed ]]
+- lectures
+       [[ schema needed ]]
+- notes
+       [[ schema needed ]]
+- posts
+       [[ schema needed ]]
+- schools
+       [[ schema needed ]]
+- sessions
+       [[ schema needed ]]
+- users
+       [[ schema needed ]]
+
+
+
 # Source Code
 
 The source code for the website itself consists of these main parts:

diff --git a/app.js b/app.js
index 56350b94c71356c681ef4a1111d11a4de2022bcb..722e164d76d40103e57825360bf2c37687d93320 100644 (file)
--- a/app.js
+++ b/app.js
@@ -1648,9 +1648,13 @@ app.get( '/archive/note/:id', loadUser, function( req, res ) {
 //
 // Data types:
 // Posts -  Posts are the main items in backchannel, useful for questions or discussion points
+//             [[ example object needed]]
 // Comments - Comments are replies to posts, for clarification or answering questions
+//             [[ example object needed]]
 // Votes - Votes signifyg a users approval of a post
+//             [[ example object needed]]
 // Flags - Flagging a post signifies that it is against the rules, 2 flags moves it to the bottomw
+//             [[ example object needed]]
 //
 //
 // Post Schema
@@ -1662,7 +1666,9 @@ app.get( '/archive/note/:id', loadUser, function( req, res ) {
 // date - Date post was made, updates when any comments are made for the post
 // comments - An array of comments which contain a body, userName, and userAffil
 // votes - An array of user ids which are the users that voted
+//             [[ example needed ]]
 // reports - An array of user ids which are the users that reported the post
+//             [[ reports would be "this post is flagged as inappropriate"? ]]
 //
 // Posts and comments can be made anonymously. When a post is anonymous, the users info is stripped
 // from the post and the userName is set to Anonymous and the userAffil to N/A. This is to allow