Home Erkunden Hilfe
Registrieren Anmelden
avalanche
/
avalanche2
Beobachten 2
Markieren 0
Fork 0

Quellcode durchsuchen
modifications to the readme file

James Peret vor 10 Jahren
Ursprung
962c92d65d
Commit
a15f6e70c0
1 geänderte Dateien mit 93 neuen Zeilen und 40 gelöschten Zeilen
Diff-Statistik anzeigen
  1. 93 40
      readme.md

+ 93 - 40
readme.md
Datei anzeigen 

@@ -28,66 +28,119 @@ Second prototype source code of the avalanche network web app.
28 28 
 ## Env Variables
29 29
30 30 
 ```yml
31 
-	AWS_ACCESS_KEY_ID:
32 
-	AWS_SECRET_ACCESS_KEY:
33 
-	AWS_S3_BUCKET:
34 
-	AWS_S3_BUCKET_REGION:
35 
-	HEROKU_APP_URL:
36 
-	MANDRILL_USERNAME:
37 
-	MANDRILL_KEY:
38 
-	DOMAIN_NAME:
39 
-	SERVER_EMAIL:
40 
-	DEVISE_SECRET_KEY:
41 
-	SECRET_KEY_BASE:
42 
-	MAILCHIMP_KEY:
43 
-	MAILCHIMP_LIST_ID:
44 
-	REDISTOGO_URL:
31 
+AWS_ACCESS_KEY_ID:
32 
+AWS_SECRET_ACCESS_KEY:
33 
+AWS_S3_BUCKET:
34 
+AWS_S3_BUCKET_REGION:
35 
+HEROKU_APP_URL:
36 
+MANDRILL_USERNAME:
37 
+MANDRILL_KEY:
38 
+DOMAIN_NAME:
39 
+SERVER_EMAIL:
40 
+DEVISE_SECRET_KEY:
41 
+SECRET_KEY_BASE:
42 
+MAILCHIMP_KEY:
43 
+MAILCHIMP_LIST_ID:
44 
+REDISTOGO_URL:
45 45 
 ```
46 46
47 
-## Notes
47 
+---------------
48 
+
49 
+
50 
+# Avalanche2 Dev Notes
51 
+
52 
+## System Scaffolding
48 53
49 
-agent_step
50 
-   - step_validations
51 
-   - step_submissions
52 
-       - step_verification
53 
-
54 
-# Avalacnhe2 system scaffolding and notes
55 54 
 ```shell
56 55
56 
+# Mission
57 57 
 rails g scaffold mission mission_agents:references title:string objective:string briefing:text owner:references status:integer launched:boolean
58 58 
 language:string cover_img:string
59 59
60 
+# Mission Agents
60 61 
 rails g model mission_agent mission:references agent_steps:references mission_candidates:references objective:string briefing:text role:string
61 62 
 description:text user:references agent_number:integer debriefing:text
62 63
64 
+# Mission Agent Steps
63 65 
 rails g model agent_step mission_agent:references step:integer title:string description:text completed:bool completed_date:datetime
64 66
67 
+# Mission Agent Candidates
68 
+rails g model mission_candidate user:reference mission_agent:reference status:integer
69 
+
70 
+# Step Validations
65 71 
 rails g model step_validation agent_step:reference step_verifications:references mode:string description:string
66 72
73 
+# Step Verifications
67 74 
 rails g model step_verification step_validation:references validated:boolean validated_by:references content:string
68 75
69 
-rails g model mission_candidate user:reference mission_agent:reference status:integer
70 
-
71 76 
 ```
72 77
73 
-# Undone
78 
+## Undone Commands
74 79
75 80 
 ```shell
76 
-rails g model agent_reward mission_agent:reference category:string title:string description:text img:string
81 
+# Reward Model
82 
+rails g model agent_reward mission_agent:references category:string title:string description:text img:string
83 
+
84 
+# Validation Scaffolding
85 
+rails destroy model step_validation
86 
+rails destroy model step_verification
87 
+rails g migration AddStepSubmissionToAgentStep step_submissions:references
88 
+
89 
+# Step Validation
90 
+rails g model step_validation agent_step:references validation_id:integer validation_type
91 
+
92 
+# Text Validation
93 
+rails g model validation_text step_validation:references description
94 
+
95 
+# Step Submission
96 
+rails g model step_submission agent_step:reference submission_contents:references validated:boolean validated_by:references date_validated:datetime
97 
+
98 
+# Submission content
99 
+rails g model submission_content submission_content:references submission_id:integer submission_type
100 
+
101 
+# Text Submission
102 
+rails g model submission_text submission_content:references content
103 
+
77 104 
 ```
78 105
79 
-mission controller
80 
-agent controller
81 
-mission_list_controller
82 
-settings_controller
83 
-
84 
-mission_list_index
85 
-agent_dashboard
86 
-mission_index
87 
-mission_show
88 
-mission_edit/create
89 
-
90 
-Emails:
91 
-- pending missions (3-5 days pending steps)
92 
-- Mission Acomplished
93 
-- Mission Failed
106 
+## To dos
107 
+
108 
+* mission controller
109 
+* agent controller
110 
+* mission_list_controller
111 
+* settings_controller
112 
+* mission_list_index
113 
+* agent_dashboard
114 
+* mission_index
115 
+* mission_show
116 
+* mission_edit/create
117 
+* emails:
118 
+	* pending missions (3-5 days pending steps)
119 
+	* Mission Acomplished
120 
+	* Mission Failed
121 
+
122 
+## Notes
123 
+
124 
+### Step Validation
125 
+
126 
+Each *agent_step* has many associated classes for storing validation details, user generated content and verification signing.
127 
+
128 
+* agent_step
129 
+	* step_validations
130 
+		* validation_text
131 
+		* validation_image
132 
+		* validation_agent_position
133 
+		* validation_git_hooks
134 
+	* step_submissions
135 
+		* step_verification
136 
+		* submission_content
137 
+			* submission_text
138 
+			* submission_image
139 
+			* submission_agent_position
140 
+			* submission_git_hooks
141 
+
142 
+Each step can have multiple step validations that are set by the mission director. Each *step_validation* can have one validation type like text, image or agent position. Every time an agent submits the information requested by the *step_validations*, a *step_submission* object is created with multiple *sumission_content* objects, one for each *step_validation*. The *submission_content* types can bem text, image or agent_position and they will store this information sent by the agent and process it.
143 
+
144 
+The *submission_content* class is also responsible for triggering the automatic validation that some *step_validations* might have. If the validation requires an operator decision, than the *step_submission* will show up on the mission control panel for manual validation. If the step can be automatic validated, than the system will create a *step_verification* for the current submission.
145 
+
146 
+----------------------