Merge branch 'master' into feature-schema-relatedcode-property

Author: RicardoAReyes

CONTRIBUTING.md

@@ -7,6 +7,7 @@ We encourage you to read this project's CONTRIBUTING policy (you are here), its
 ## How to contribute to code-gov-web
 
 - Report bugs and request features via [Github Issues](https://github.com/GSA/code-gov-web/issues).
+   - If you are not sure that the issue is related to the website you can [create the issue in our general repository](https://github.com/gsa/code-gov/issue/new): [code-gov](https://github.com/gsa/code-gov)
 - Join the [mailing list](http://code.us15.list-manage.com/subscribe?u=57dec439b29289fc14396b8db&id=a317168ea7) and stay up to date with our latest news.
 - [Share your ideas](mailto://[email protected]) for how to improve code-gov-web. We're always open to suggestions.
 - Create a [Github pull request](https://help.github.com/articles/creating-a-pull-request/) with new functionality or fixing a bug.

README.md

@@ -13,7 +13,7 @@ To learn more about the project, check out this [blog post](https://www.whitehou
 
 Code.gov is an open source project, so we invite your contributions, be it in the form of code, design, or ideas.
 
-## Project Timeline
+## Requirements
 
 The development of code.gov is guided by the requirements set forth in [Section 7.2 (Code Inventories and Discovery)](https://sourcecode.cio.gov/Implementation/#code-inventories-and-discovery), [Section 7.3 (Code.gov)](https://sourcecode.cio.gov/Implementation/#codegov), and  [Section 7.6 (Agency Policy)](https://sourcecode.cio.gov/Implementation/#agency-policy) of the Federal Source Code Policy. Namely:
 
@@ -23,10 +23,6 @@ The development of code.gov is guided by the requirements set forth in [Section
 >
 > * "Within 120 days of the publication date of this policy, each agency must update—and thereafter keep up to date—its inventory of agency information resources to include an enterprise code inventory that lists custom-developed code for or by the agency after the publication of this policy."
 
-Over the next few weeks, we will begin the *discovery sprint* for code.gov. During that time, we will conduct user interviews and engage this community in discussions that will inform the user experience for code.gov.
-
-After the discovery sprint, we'll begin building the site. We'll be relying on input from the community and from agencies about what features should be delivered first. That list of features will drive the *design sprint* and *development sprint*. And because this site is being developed in the open, you will be able to make contributions and provide feedback here as we go.
-
 ## Configuration
 For documentation on how to configure code-gov-web, go [here](https://github.com/GSA/code-gov-web/blob/master/CONFIGURATION.md).
 
@@ -100,7 +96,12 @@ API_URL='https://code-api-staging.app.cloud.gov/api/' npm run start
 API_URL=staging GIT_REMOTE_NAME=upstream npm run federalist-deploy:dev
 ```
 
-
+## Specifying an API Key
+The app uses the API key provided in the code-gov-config.json by default.
+If you want to override that, specify an `CODE_GOV_API_KEY` environmental variable.  Here's an example:
+```
+CODE_GOV_API_KEY=l87sfdi7ybc2bic7bai8cb2i176c3b872tb3 npm run server
+```
 
 ## Deployment Problems
 When pushing to staging or dev branches, you might run into an occasional error warning that the branch you're pushing to already exists. If you see this, you need to clear the cache in the gh-pages module using this command: `rm -rf node_modules/gh-pages/.cache`
@@ -129,6 +130,9 @@ This app follows the
 [official Angular Style Guide](https://angular.io/styleguide). Please ensure you
 follow the naming conventions defined in this guide.
 
+## Vocabulary
+We sometimes use the word `entities`.  It basically means something that has repositories.  Agencies are types of entities.
+
 ## License
 
 As stated in [CONTRIBUTING](CONTRIBUTING.md):

config/examples/code-dot-gov.json

@@ -19,27 +19,27 @@
         {
           "name": "about",
           "links": [
-            { "name": "Source Code Policy", "url": "/#/policy-guide/docs/overview/introduction" },
-            { "name": "Open Source Pilot", "url": "/#/policy-guide/docs/open-source/introduction" }
+            { "name": "Source Code Policy", "url": "/#!/policy-guide/docs/overview/introduction" },
+            { "name": "Open Source Pilot", "url": "/#!/policy-guide/docs/open-source/introduction" }
           ]
         },
         {
           "name": "Browse Projects",
-          "url": "/#/explore-code/agencies/NASA"
+          "url": "/#!/browse-projects"
         },
         {
           "name": "federal agencies",
           "links": [
-            { "name": "How to Inventory Code", "url": "/#/policy-guide/docs/compliance/inventory-code" },
-            { "name": "Tools", "url": "/#/policy-guide/docs/compliance/inventory-code/tools/validate-schema" },
-            { "name": "Compliance Dashboard", "url": "/#/policy-guide/docs/compliance/dashboard"}
+            { "name": "How to Inventory Code", "url": "/#!/policy-guide/docs/compliance/inventory-code" },
+            { "name": "Tools", "url": "/#!/policy-guide/docs/compliance/inventory-code/tools/validate-schema" },
+            { "name": "Compliance Dashboard", "url": "/#!/policy-guide/docs/compliance/dashboard"}
           ]
         },
         {
           "name": "developers",
           "links": [
             { "name": "code.gov API", "url": "https://developers.code.gov/basics.html" },
-            { "name": "Contribute", "url": "/#/help-wanted" },
+            { "name": "Contribute", "url": "/#!/help-wanted" },
             { "name": "Notebooks", "url": "https://beta.observablehq.com/search?query=%22code.gov%22" }
           ]
         },
@@ -59,9 +59,16 @@
       "banner": {
         "motto": "Sharing America's Code",
         "subtitle": "Unlock the tremendous potential of the Federal Government’s software.",
-        "help_wanted_description": "Discover how you can get involved and make America's code better",
-        "search_placeholder_text": "Search Thousands of Projects...",
-        "browse_by_text": "Browse by Agency"
+        "help_wanted": {
+          "title": "Ready. Set. Code!",
+          "description": "Whether you are a beginner or an experienced coder, join the open source community. Help improve America's Code.",
+          "button": "Explore Open Tasks"
+        },
+        "search_description_text": "Search thousands of Federal Government projects",
+        "search_description_text_mobile": "Search projects",
+        "search_placeholder_text": "e.g. JavaScript, NASA, web standards",
+        "browse_by_text": "Browse by Agency",
+        "issue_url": "https://github.com/GSA/code-gov-web/issues"
       },
       "mission": "Code.gov leverages the power of code sharing and collaboration to help the US Government cut down on duplicative software development and save millions of taxpayer dollars for the American people.",
       "about": [
@@ -92,7 +99,7 @@
           "description": "A python package designed to simulate and analyze resilience of water distribution networks.",
           "image": "/assets/img/featured-projects/pipes4.png",
           "links": [
-            { "name": "View Project", "url": "/#/explore-code/agencies/DOE/repos/doe_snl_water_network_tool_for_resilience_v_1_0" },
+            { "name": "View Project", "url": "/#!/explore-code/agencies/DOE/repos/doe_sandia_national_laboratories_snl_water_network_tool_for_resilience_v_1_0" },
             { "name": "Go to Repo", "url": "https://github.com/usepa/wntr"}
           ]
         },
@@ -103,7 +110,7 @@
           "description": "A real-time virtual data router that ingests and processes operational data from various connected devices including vehicles, infrastructure, and traffic management centers and distributes it to other devices and subscribing transportation management applications.",
           "image": "/assets/img/featured-projects/smartcity4.png",
           "links": [
-            { "name": "View Project", "url": "/#/explore-code/agencies/DOT/repos/dot_fhwa_intelligent_transportation_systems_operational_data_environment_its_ode_" },
+            { "name": "View Project", "url": "/#!/explore-code/agencies/DOT/repos/dot_fhwa_intelligent_transportation_systems_operational_data_environment_its_ode_" },
             { "name": "Go to Repo", "url": "https://github.com/usdot-jpo-ode/jpo-ode" }
           ]
         },
@@ -114,7 +121,7 @@
           "description": "Enables security teams to integrate apps, workflows, and analytics tools that would otherwise need to be created from scratch.",
           "image": "/assets/img/featured-projects/WALKOFF.png",
           "links": [
-            { "name": "View Project", "url": "/#/explore-code/agencies/NSA/repos/nsa_walkoff" },
+            { "name": "View Project", "url": "/#!/explore-code/agencies/NSA/repos/nsa_walkoff" },
             { "name": "Go to Repo", "url": "https://github.com/iadgov/WALKOFF" }
           ]
         }
@@ -123,19 +130,23 @@
         "quote": "It’s the latest in a long line of high-profile victories for the open source movement.",
         "attribution": {
           "image": "assets/img/logos/press/wired.svg",
+          "alt": "wired magazine",
           "url": "https://www.wired.com/2016/08/open-source-won-now/"
         },
         "links": [
           {
             "image": "assets/img/logos/press/techcrunch.jpg",
+            "alt": "techcrunch",
             "url": "https://techcrunch.com/2016/08/08/the-white-house-just-released-the-federal-source-code-policy-to-help-government-agencies-go-open-source/"
           },
           {
             "image": "assets/img/logos/press/pcmag.png",
+            "alt": "pc magazine",
             "url": "http://www.pcmag.com/news/346860/white-house-releases-open-source-software-policy"
           },
           {
             "image": "assets/img/logos/press/fcw.png",
+            "alt": "federal computer week",
             "url": "https://fcw.com/articles/2016/08/08/open-source-rockwell.aspx"
           }
         ]
@@ -145,7 +156,11 @@
       "links": [
         {
           "name": "Privacy Policy",
-          "url": "/#/privacy-policy"
+          "url": "/#!/privacy-policy"
+        },
+        {
+          "name": "Roadmap",
+          "url": "/#!/roadmap"
         },
         {
           "name": "Visit Project Page",
@@ -174,34 +189,36 @@
       "browse_by_text": "Browse by Agency"
     },
     "help_wanted": {
-      "title": "Help Wanted",
-      "subtitle": "Discover how you can get involved and make Your City's Code better"
+      "title": "Open Tasks",
+      "subtitle": "Ready. Set. Code!"
     },
     "roadmap": {
       "overview": [
         "At Code.gov, we know it’s important to keep an open dialogue with our users. That’s why we’re sharing our plans for the future through this Development Roadmap. Hopefully, it will help you better understand our priorities for the platform.",
         "The Development Roadmap is organized into three categories – Near-term, Mid-term, and Long-term. Priorities are sorted into roadmap categories based on feedback we receive during user interviews. Dependencies and resources are also factors that affect placement on the roadmap. If you want to join the Code.gov user testing group, please email us at <a href='mailto:[email protected]'>[email protected]</a>."
       ],
       "near": [
-        { "name": "Search results", "status": "Released" },
-        { "name": "Project Details Phase I", "status": "Released" },
-        { "name": "Help wanted", "status": "Released" },
-        { "name": "Roadmap on site", "status": "Released" },
-        { "name": "Enhanced compliance dashboard", "status": "Released" },
-        { "name": "Increased agency participation", "status": "Released" },
-        { "name": "Metadata schema 1.0 & 1.0.1 deprecation", "status": "Released" }
+        { "name": "Code.gov configurability with Angular", "status": "Released" },
+        { "name": "Update Navigation and Homepage content", "status": "Released" },
+        { "name": "Usability sessions, round 1", "status": "Released" },
+        { "name": "Phase 1 SEO improvements", "status": "In Progress" },
+        { "name": "Licenses documentation", "status": "In Progress" },
+        { "name": "Search scoring phase 1", "status": "In Progress" },
+        { "name": "Update search filters", "status": "In Progress" }
       ],
       "mid": [
-        { "name": "Agency pages", "status": null },
-        { "name": "Medium skin", "status": null },
-        { "name": "FAQs page", "status": "In Progress" },
-        { "name": "Admin tool", "status": null },
-        { "name": "Enhanced tools and resources", "status": null },
-        { "name": "Project Details Phase II", "status": null}
+        { "name": "Update help wanted phase 1", "status": null },
+        { "name": "Update UI for search results", "status": null },
+        { "name": "Usability sessions, round 2", "status": null }
       ],
       "long": [
-        { "name": "User accounts", "status": null },
-        { "name": "Gamification", "status": null }
+        { "name": "States and cities pilot program", "status": null },
+        { "name": "Phase 2 SEO improvements", "status": null },
+        { "name": "User profiles", "status": null },
+        { "name": "Gamification/badges", "status": null },
+        { "name": "Chatbot", "status": null },
+        { "name": "Code.json creator tool", "status": null },
+        { "name": "Search scoring phase 2", "status": null }
       ],
       "disclaimer": "This Development Roadmap (Roadmap) is for informational purposes only. The Code.gov team will update the Roadmap as frequently as possible but, given that it’s subject to change at any time, the information presented by the Roadmap should not be used for planning purposes. The information presented in the Roadmap does not represent a solicitation or similar contract vehicle. All items in the Roadmap will be developed and released at the sole discretion of Code.gov, the General Services Agency, the Office of Management and Budget, and the United States Federal Government."
     }

config/examples/pub-code.json

@@ -15,9 +15,9 @@
         "light": "./assets/img/logos/pub-code-light.svg"
       },
       "links": [
-        { "name": "Browse Projects", "url": "/#/explore-code" },
-        { "name": "Help Wanted", "url": "/#/help-wanted" },
-        { "name": "Roadmap", "url": "/#/roadmap" }
+        { "name": "Browse Projects", "url": "/#!/explore-code" },
+        { "name": "Help Wanted", "url": "/#!/help-wanted" },
+        { "name": "Roadmap", "url": "/#!/roadmap" }
       ]
     },
     "home": {
@@ -45,7 +45,7 @@
         {
           "title": "Roadmap",
           "description": "See our progress",
-          "link": "/#/roadmap",
+          "link": "/#!/roadmap",
           "image": "/assets/img/icons/check_bl.png"
         }
       ],
@@ -57,7 +57,7 @@
           "description": "The GNEIMO methods and algorithms build up on the Spatial Operator Algebra (SOA) multibody dynamics framework.",
           "image": "/assets/img/featured-projects/Science.svg",
           "links": [
-            { "name": "View Project", "url": "/#/explore-code/agencies/NASA/repos/nasa_jpl_gneimo_advanced_techniques_for_constrained_internal_coordinate_molecular_dynamics" },
+            { "name": "View Project", "url": "/#!/explore-code/agencies/NASA/repos/nasa_jpl_gneimo_advanced_techniques_for_constrained_internal_coordinate_molecular_dynamics" },
             { "name": "Go to Repo", "url": "https://software.nasa.gov/software/NPO-48712-1" }
           ]
         }
@@ -79,7 +79,7 @@
       "links": [
         {
           "name": "Privacy Policy",
-          "url": "/#/privacy-policy"
+          "url": "/#!/privacy-policy"
         },
         {
           "name": "Visit Project Page",

config/examples/your-city.json

@@ -15,9 +15,9 @@
         "light": "./assets/img/logos/your-city-light.svg"
       },
       "links": [
-        { "name": "Browse Projects", "url": "/#/explore-code" },
-        { "name": "Help Wanted", "url": "/#/help-wanted" },
-        { "name": "Roadmap", "url": "/#/roadmap" }
+        { "name": "Browse Projects", "url": "/#!/explore-code" },
+        { "name": "Help Wanted", "url": "/#!/help-wanted" },
+        { "name": "Roadmap", "url": "/#!/roadmap" }
       ]
     },
     "home": {
@@ -57,7 +57,7 @@
           "description": "A website with resource and tools for starting your own business in Your City",
           "image": "/assets/img/featured-projects/biz_400x400.png",
           "links": [
-            { "name": "View Project", "url": "/#/explore-code/agencies/" },
+            { "name": "View Project", "url": "/#!/explore-code/agencies/" },
             { "name": "Go to Repo", "url": "https://github.com/"}
           ]
         },
@@ -68,7 +68,7 @@
           "description": "A mobile-friendly online interactive map that shows transportation routes and current locations of public transportation options",
           "image": "/assets/img/featured-projects/transportation_409x409.png",
           "links": [
-            { "name": "View Project", "url": "/#/explore-code/agencies/" },
+            { "name": "View Project", "url": "/#!/explore-code/agencies/" },
             { "name": "Go to Repo", "url": "https://github.com" }
           ]
         }
@@ -78,7 +78,7 @@
       "links": [
         {
           "name": "Privacy Policy",
-          "url": "/#/privacy-policy"
+          "url": "/#!/privacy-policy"
         },
         {
           "name": "Visit Project Page",

config/webpack.common.js

@@ -51,7 +51,7 @@ module.exports = function (options) {
   } else {
     API_URL = 'https://code-api.app.cloud.gov/api/';
   }
-
+  
   const METADATA = {
     API_URL,
     baseUrl: '/',
@@ -62,6 +62,10 @@ module.exports = function (options) {
     port: process.env.PORT || (isProd ? 8080 : 2700),
     host: process.env.HOST || 'localhost'
   };
+  
+  if (process.env.CODE_GOV_API_KEY) {
+    METADATA.CODE_GOV_API_KEY = process.env.CODE_GOV_API_KEY;
+  }
 
   const copyPluginOptions = [{
     from: 'src/assets',
@@ -133,10 +137,7 @@ module.exports = function (options) {
           }),
         ],
         sassLoader: {
-          includePaths: [
-            require('bourbon').includePaths,
-            require('bourbon-neat').includePaths,
-          ]
+          includePaths: []
         },
         tslint: {
           emitErrors: isProd ? true : false,
@@ -160,6 +161,7 @@ module.exports = function (options) {
       'ENV': JSON.stringify(METADATA.ENV),
       'HMR': METADATA.HMR,
       'process.env': {
+        'CODE_GOV_API_KEY': JSON.stringify(METADATA.CODE_GOV_API_KEY),
         'API_URL': JSON.stringify(METADATA.API_URL),
         'ENV': JSON.stringify(METADATA.ENV),
         'NODE_ENV': JSON.stringify(METADATA.ENV),

config/webpack.federalist-deploy.js

@@ -111,10 +111,7 @@ module.exports = function (env) {
             }),
           ],
           sassLoader: {
-            includePaths: [
-              require('bourbon').includePaths,
-              require('bourbon-neat').includePaths
-            ]
+            includePaths: []
           }
         }
       }),

config/webpack.test.js

@@ -237,10 +237,7 @@ module.exports = function (options) {
            * See: https://github.com/wbuchwalter/tslint-loader
            */
           sassLoader: {
-            includePaths: [
-              require('bourbon').includePaths,
-              require('bourbon-neat').includePaths
-            ]
+            includePaths: []
           },
 
           tslint: {