Merge pull request #333 from poorgeek/about-us

About us

ABOUT.md

@@ -0,0 +1,25 @@
+# About
+
+The HMDA Pilot is a work in progress by the [Consumer Financial Protection Bureau](http://consumerfinance.gov/) to provide a new way to validate HMDA data. The application makes it easier to review and verify validation edits.
+
+## Validate a HMDA Dataset
+
+1. **Select a .DAT file**
+
+    On the File and Validate page (Step 1), select a properly formatted .DAT file and filing year, then click the Start Validation button. When the validation starts, the file will remain on your computer and will not be uploaded.
+
+2. **Validate Data**
+
+    The validation edits must be performed in the order shown below. For each step, the file must pass all edits and be verified before proceeding with the next step.
+
+    * Syntactical & Validity Edits
+    * Quality & Macro Edits
+    * MSA and IRS Edits
+
+3. **Review Edit Reports**
+
+    Validation errors will be displayed in the Edit Reports and Edit Details pages. If needed, make corrections in your system of record and revalidate the entire file (starting at Step 1).
+
+4. **Review Validation Summary**
+
+    After all edits are complete the Validation Summary will display the Respondent and File information. You do not need to submit the validated file or send an additional information.

COMMON_QUESTIONS.md

@@ -0,0 +1,5 @@
+# Commonly Asked Questions
+
+1. Why can't I skip ahead from Syntactical/validity to Quality before you fixing my Syntactical/Validity edit errors?
+
+1. When you recheck the file that you have fixed, you need to recheck the full file and not just the changes

Gruntfile.js

@@ -64,6 +64,10 @@ module.exports = function (grunt) {
       gruntfile: {
         files: ['Gruntfile.js']
       },
+      markdown: {
+        files: ['ABOUT.md', 'COMMON_QUESTIONS.md'],
+        tasks: ['markdown:help']
+      },
       livereload: {
         options: {
           livereload: '<%= connect.options.livereload %>'
@@ -499,6 +503,17 @@ module.exports = function (grunt) {
     },
     ngdocs: {
       all: ['<%= yeoman.app %>/scripts/{,*/}*.js']
+    },
+    markdown: {
+        help: {
+            files: [{
+                'app/partials/about.html': 'ABOUT.md',
+                'app/views/common_questions.html': 'COMMON_QUESTIONS.md',
+            }],
+            options: {
+                template: 'config/md-to-html.jst',
+            }
+        }
     }
   });
 
@@ -520,6 +535,7 @@ module.exports = function (grunt) {
       'concurrent:server',
       'autoprefixer',
       'replace:local',
+      'markdown:help',
       'connect:livereload',
       'watch'
     ]);
@@ -567,7 +583,8 @@ module.exports = function (grunt) {
       'uglify',
       'filerev',
       'usemin',
-      'htmlmin'
+      'htmlmin',
+      'markdown:help'
     ]);
   });
 

app/partials/about.html

@@ -0,0 +1,23 @@
+<h1 id="about">About</h1>
+<p>The HMDA Pilot is a work in progress by the <a href="http://consumerfinance.gov/">Consumer Financial Protection Bureau</a> to provide a new way to validate HMDA data. The application makes it easier to review and verify validation edits.</p>
+<h2 id="validate-a-hmda-dataset">Validate a HMDA Dataset</h2>
+<ol>
+<li><p><strong>Select a .DAT file</strong></p>
+<p> On the File and Validate page (Step 1), select a properly formatted .DAT file and filing year, then click the Start Validation button. When the validation starts, the file will remain on your computer and will not be uploaded.</p>
+</li>
+<li><p><strong>Validate Data</strong></p>
+<p> The validation edits must be performed in the order shown below. For each step, the file must pass all edits and be verified before proceeding with the next step.</p>
+<ul>
+<li>Syntactical &amp; Validity Edits</li>
+<li>Quality &amp; Macro Edits</li>
+<li>MSA and IRS Edits</li>
+</ul>
+</li>
+<li><p><strong>Review Edit Reports</strong></p>
+<p> Validation errors will be displayed in the Edit Reports and Edit Details pages. If needed, make corrections in your system of record and revalidate the entire file (starting at Step 1).</p>
+</li>
+<li><p><strong>Review Validation Summary</strong></p>
+<p> After all edits are complete the Validation Summary will display the Respondent and File information. You do not need to submit the validated file or send an additional information.</p>
+</li>
+</ol>
+

app/partials/header.html

@@ -8,6 +8,11 @@
             <h1><a class="title-link" href="#/">HMDA Pilot</a></h1>
         </div>
 
+        <ul class="site-nav">
+            <li><a href="#/about" target="help">About</a></li>
+            <li><a href="#/common-questions" target="help">Common Questions</a></li>
+        </ul>
+
         <div class="site-logo">
             <a href="http://www.consumerfinance.gov"><img class="logo" src="images/logo_210.png" alt="Consumer Financial Protection Bureau"></a>
         </div>

app/partials/wizardNav.html

@@ -1,4 +1,4 @@
-<nav class="nav-wizard">
+<nav class="nav-wizard" ng-if="showWizardNav()">
     <ol>
         <li ng-repeat="step in steps" class="step {{step.stepClass}}">
             <span class="{{step.badgeClass}}">{{step.badgeText}}</span>

app/scripts/app.js

@@ -71,6 +71,12 @@ angular
         templateUrl: 'views/reportIRS.html',
         controller: 'IRSReportCtrl'
       })
+      .when('/about', {
+        templateUrl: 'views/about.html'
+      })
+      .when('/common-questions', {
+        templateUrl: 'views/common_questions.html'
+      })
       .otherwise({
         redirectTo: '/'
       });
@@ -84,7 +90,7 @@ angular
     $rootScope.$watch(function() {
         return HMDAEngine.getHmdaJson();
     }, function(newVal) {
-        if (angular.equals({}, newVal)) {
+        if (angular.equals({}, newVal) && ['/about', '/common-questions'].indexOf($location.path()) === -1) {
             $location.path('/');
         }
     });

app/scripts/directives/wizardNav.js

@@ -64,6 +64,11 @@ module.exports = /*@ngInject*/ function ($location, $timeout, StepFactory, Wizar
             // Initialize scope variables
             scope.steps = [];
 
+            // Determine if the wizard nav should be displayed or not
+            scope.showWizardNav = function() {
+                return ['/about', '/common-questions'].indexOf($location.path()) === -1;
+            };
+
             // Watch the Wizard steps to see if they change
             scope.$watch(function() {
                 return Wizard.getCurrentStep();

app/styles/hmda-pilot.less

@@ -38,6 +38,21 @@
 body {
     .webfont-regular;
 }
+
+ul.site-nav {
+    list-style: none;
+    margin: 0;
+    padding: 0;
+    position: absolute;
+    top: 18px;
+    right: 255px;
+
+    li {
+        display: inline-block;
+        margin-right: 10px;
+    }
+}
+
 footer {
     margin-top: 3em;
 }

app/views/about.html

@@ -0,0 +1,15 @@
+<div class="content-l">
+    <div class="content-l_col content-l_col-2-3">
+        <ng-include src="'partials/about.html'"></ng-include>
+    </div>
+    <div class="content-l_col content-l_col-1-3">
+        <h2>Resources</h2>
+        <ul class="list-unstyled">
+            <li><a href="http://www.ffiec.gov/hmda/guide.htm" target="_blank">A Guide To HMDA Reporting: Getting It Right!</a></li>
+            <li><a href="http://www.ffiec.gov/hmda/edits.htm" target="_blank">HMDA Edits (Quality, Validity, Syntactical)</a></li>
+            <li><a href="http://www.ffiec.gov/hmda/glossary.htm" target="_blank">HMDA Glossary</a></li>
+            <li><a href="http://www.ffiec.gov/hmda/fileformats.htm" target="_blank">HMDA File Specifications</a></li>
+        </ul>
+    </div>
+</div>
+

app/views/common_questions.html

@@ -0,0 +1,8 @@
+<h1 id="commonly-asked-questions">Commonly Asked Questions</h1>
+<ol>
+<li><p>Why can&#39;t I skip ahead from Syntactical/validity to Quality before you fixing my Syntactical/Validity edit errors?</p>
+</li>
+<li><p>When you recheck the file that you have fixed, you need to recheck the full file and not just the changes</p>
+</li>
+</ol>
+

config/md-to-html.jst

@@ -0,0 +1 @@
+<%=content%>

package.json

@@ -61,6 +61,7 @@
     "grunt-google-cdn": "^0.4.0",
     "grunt-karma": "^0.9.0",
     "grunt-karma-coveralls": "^2.5.3",
+    "grunt-markdown": "^0.7.0",
     "grunt-newer": "^0.7.0",
     "grunt-ng-annotate": "^0.8.0",
     "grunt-ngdocs": "^0.2.7",
@@ -89,7 +90,9 @@
     "install": "napa"
   },
   "browserify": {
-    "transform": [ "browserify-shim" ]
+    "transform": [
+      "browserify-shim"
+    ]
   },
   "browser": {
     "angular": "./node_modules/angular/angular.js"

test/spec/directives/wizardNav.js

@@ -130,4 +130,18 @@ describe('Directive: WizardNav', function () {
             expect(ngDialog.openConfirm).not.toHaveBeenCalled();
         });
     });
+
+    describe('when navigating to help pages', function() {
+        it('should not display the wizard nav on the About page', function() {
+            location.path('/about');
+            scope.$digest();
+            expect(element.children().length).toBeFalsy();
+        });
+
+        it('should not display the wizard nav on the Common Questions page', function() {
+            location.path('/common-questions');
+            scope.$digest();
+            expect(element.children().length).toBeFalsy();
+        });
+    });
 });