Merged in feature/autodocs (pull request #94)

Auto Docs for all cmds

* docs

cmd/docCleanRunner/main.go

@@ -1,3 +1,10 @@
+// **Listens For**: Body Containing Document ID.
+//
+// **Action**.
+//
+// If the document is not already clean according to the job collector standards, a clean is triggered.
+//
+// An event with the document id is pushed to the DOCTEXT queue.
 package main
 
 import (

cmd/docInitRunner/main.go

@@ -1,3 +1,18 @@
+// **Listens For**: S3 Event notifications - limited to PUT notifications.
+//
+// **Action**.
+//
+// Checks if the uploaded document is a duplicate.
+//
+// Currently whether the document content is a duplicate or not is determines using the document ETag, and check if it already exists for the job.
+//
+// Find reference entity.
+//
+// If NOT a duplicate - Create a document reference entity.
+//
+// Create a document entry to log the successful upload of a document.
+//
+// Add an event to the DOC SYNC queue.
 package main
 
 import (

cmd/docSyncRunner/main.go

@@ -1,3 +1,12 @@
+// **Listens For**: Body Containing Document ID.
+//
+// **Action**.
+//
+// Checks if the document is eligible for syncing.
+//
+// By validating: the client can_sync parameter, the job can_sync parameter.
+//
+// If eligible, send an event to the DOCCLEAN queue.
 package main
 
 import (

cmd/docTextRunner/main.go

@@ -1,3 +1,10 @@
+// **Listens For**: Body Containing Document ID
+//
+// **Action**.
+//
+// If the document text is not already extracted according to the job collector standards, the text is extracted.
+//
+// An event with the document id is pushed to the QUERYSYNC queue.
 package main
 
 import (

cmd/jobSyncRunner/main.go

@@ -1,3 +1,8 @@
+// **Listens For**: Body Containing Job ID
+//
+// **Action**.
+//
+// Adds an event for each document into the DOCSYNC queue for the given Job.
 package main
 
 import (

cmd/queryRunner/main.go

@@ -1,3 +1,10 @@
+// **Listens For**: Body Containing Document ID and Query ID
+//
+// **Action**.
+//
+// Run the query for the given document and store the result.
+//
+// Events with the document id and downstream query ids are pushed to the QUERY queue.
 package main
 
 import (

cmd/querySyncRunner/main.go

@@ -1,3 +1,18 @@
+// **Listens For**: Body Containing Document ID
+//
+// **Action**.
+//
+// Find the queries with no dependencies that do not have a valid result for a document.
+//
+// The reasoning for only extracting these is to start the query extraction process only for necessary queries, and the query runner will manage updating downstream dependencies.
+//
+// There are 2 situations that cause a query to show up in this list:
+//
+// The query has no required dependencies.
+//
+// All required dependencies have a valid result.
+//
+// An event with the document id is pushed to the DOCTEXT queue.
 package main
 
 import (

cmd/queryVersionSyncRunner/main.go

@@ -1,3 +1,8 @@
+// **Listens For**: Body Containing Query ID
+//
+// **Action**.
+//
+// Adds an event for each job into the JOBSYNC queue for the given query, i.e. each job that contains the query in its dependency tree.
 package main
 
 import (