Merge branch 'master' of http://gitlab.iath.virginia.edu/snac/Documentation

Help-using-gitlab.md

-
 ### Info about Markdown
 
 You can edit markdown files from the Gitlab web site. From the Gitlab home page, click a project on the right
@@ -28,6 +27,30 @@ to edit files, but usually people work on their local computers.
 It is a more efficient work flow to work on files locally on your own computer, and use git tools to push the
 modified files back to the Gitlab repository. 
 
+#### SSH key requirements
+
+Generate an ssh key:
+```
+ssh-keygen -t dsa
+```
+
+Add the key via your gitlab profile settings -> ssh keys.
+Edit your ~/.ssh/config file to contain a section like the following:
+
+```
+Host gitlab gitlab.iath.virginia.edu
+user git
+Hostname gitlab.iath.virginia.edu
+IdentityFile ~/.ssh/gitlab_id_dsa
+EscapeChar none
+```
+
+To see the ssh key finger print, use the -lf switch:
+```
+ssh-keygen -lf ~/.ssh/gitlab_id_dsa
+```
+
+
 Important: the URL to "clone" a repository can be found on each project's main page. It will be an SSH URL beginning with "git..." or an HTTP URL beginning with "http..."
 
 ```
@@ -60,5 +83,4 @@ http://doc.gitlab.com/ce/ssh/README.html
 https://confluence.atlassian.com/display/STASH/Creating+SSH+keys#CreatingSSHkeys-CreatinganSSHkeyonWindows
 
 #### Mac github, requires 10.9, probably github only.
-https://mac.github.com/
-
+https://mac.github.com/
\ No newline at end of file

tat_requirements/introduction.md

 TAT Functional Requirements
 
-Authors
-=======
+#### Authors
+
 
 Tom Laudeman, Technical lead, University of Virginia, Institute for
 Advanced Technology in the Humanities
@@ -16,34 +16,16 @@ Ray R. Larson, U.C. Berkeley - School of Information
 
 Robbie Hott
 
-(other authors add yourselves here)
-
-### Discussion items:
+#### Organization of documenatation
 
-The order of files is:
+[Plan](plan.md) (external, broad view roadmap)
 
-plan (external, broad view roadmap)
+[Introduction (this document) ](introduction.md)
 
-introduction
+[Requirements](requirements.md)
 
 co-op background
 
-requirements
-
-What are .c and .r files in the merged data?
-
-If an .c file is creatorOf (presumably a resourceRelation) where is that
-preserved in the merged data? Check this out vis-a-vis the cpf SQL db.
-
-Edit UI data field validation API
-
-Most data entry needs validation, so we should plan for a validation
-layer that interacts with the UI and with the database. The ideal
-architecture is rule based validation as opposed to some hard coded ad
-hoc system. It would be even better if the rules were saved to the
-database and had a UI of their own, allowing non-programmers to update
-data validation rules (and the concomitant messages show to users when
-there is a validation error).
 
 #### Edit architecture requirements
 

tat_requirements/plan.md

@@ -29,6 +29,19 @@
 
 #### Code we write
 
+- Data validation API
+
+  - rule based system abstracted out of the code
+  - rules are data
+  - change the rules, not the actual application code 
+  - rules for broad classes of data type, or granular rules for individual fields
+  - probably used this to untaint data as well (remove things that are potential security problems)
+  - send all data through this API
+  - every rule includes a message describing what when wrong and suggesting fixes
+  - rules potentially editable by non-programmers
+  - rules are based on co-op data policies, which implies a data policy document, or the rules **can** be the
+    policy documentation.
+
 - Identitiy Reconciliation (aka IR) (architect Robbie)
 
  - needs docs wrangled

tat_requirements/snac-web-app-wrapper.md

+
+
+
+![SNAC web app API data flow](images/image02.png)
+
+