Merge branch 'master' into get-statuses-from-api

Author: Froilan Irizarry

CONFIGURATION.md

@@ -0,0 +1,54 @@
+# Configuration of code-gov-web
+code-gov-web is configurable.  You can customize the styling, content and much more by adding to and updating the `code-gov-config.json` file found at [code-gov-web/config/code-gov-config.json](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json)
+
+# Domain
+If you want to host code-gov-web on your own domain, you'll have to change the CNAME file found at [code-gov-web/config/CNAME](https://github.com/GSA/code-gov-web/blob/master/config/CNAME)
+
+# [title](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L2)
+To change the title of the website change the `title` property in `code-gov-web/config/code-gov-config.json`
+
+# [twitter handle](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L9)
+You can add the handle for your twitter account.  This is used to generate the link for the Twitter icon in the top right of each page.  Update the handle property in `code-gov-web/config/code-gov-config.json`
+
+# [homepage](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L12)
+You can configure everything on the home page.
+
+### [banner](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L13)
+You can configure the content inside of the banner area.  You change the motto `Sharing America's Code` to whatever you want.  You can also change the subtitle, `Unlock the tremendous...`, and description of the help wanted tasks, `Discover how you can...`
+
+# [roadmap](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L108)
+The roadmap section is fully configurable.  You can see a live example of what the roadmap looks like here: https://code.gov/#/roadmap
+
+### [overview](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L109)
+You can configure the text that appears under [overview](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L109).  This is represented as an array of paragraph HTML text.
+```
+"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:code@gsa.gov'>Code@gsa.gov</a>."
+],
+```
+### [near-, mid-, and long-term tasks](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L113)
+You can configure your [tasks](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L113) for different time durations.  They are represented as an array of task objects with each task object including two properties, `name` and `status`.  The status can be of three options: `Released`, `In Progress`, or `null`.  Here's an example of configuring the mid-term tasks:
+```
+"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}
+],
+```
+
+### [disclaimer](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L134)
+You can also add a [disclaimer](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L134) that says you can't guarantee that features are rolled out according to the roadmap
+```
+"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."
+```
+
+
+# more soon
+There's many other ways to customize code-gov-web.  More documentation coming soon!
+
+# contact
+If you have any questions, you can post an issue on GitHub or email us at code@gsa.gov

CONTRIBUTING.md

@@ -4,18 +4,18 @@ We're so glad you're thinking about contributing to a U.S. Government open sourc
 
 We encourage you to read this project's CONTRIBUTING policy (you are here), its [LICENSE](LICENSE.md), and its [README](README.md).
 
-## How to contribute to Code.gov
+## How to contribute to code-gov-web
 
-- Report bugs and request features via [Github Issues](https://github.com/GSA/code-gov-api/issues).
+- Report bugs and request features via [Github Issues](https://github.com/GSA/code-gov-web/issues).
 - 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://code@gsa.gov) for how to improve Code.gov. We're always open to suggestions.
+- [Share your ideas](mailto://code@gsa.gov) 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.
-- Improve or create documentation for Code.gov.
+- Improve or create documentation for code-gov-web.
 - Help us improve our unit and integrations tests.
 - Triage tickets and review patches triaging-tickets created by other users.
 
 ## Public domain
 
 As noted in [LICENSE](LICENSE.md), this project is in the worldwide public domain (in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/)).
 
-All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.
+All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

LICENSE.md

@@ -4,7 +4,7 @@
 
 The Devicons font files in `src/assets/fonts` are licensed under the [MIT License](https://opensource.org/licenses/MIT), and copyright [Theodore Vorillas](https://github.com/vorillaz).
 
-The FontAwesome font files in `src/assets/fonts` are from [Font Awesome](http://fontawesome.io/) by Dave Gandy under the [SIL Open Font License 1.1](http://scripts.sil.org/OFL). The FontAwesome styles located in `src/assets/fonts.css` are licensed under the [MIT License](https://opensource.org/licenses/MIT).
+The FontAwesome SVG's are found inside code-gov-font's font files.  [Font Awesome](http://fontawesome.io/) is by Dave Gandy under the [SIL Open Font License 1.1](http://scripts.sil.org/OFL).
 
 The Merriweather font files in `src/assets/fonts` are from [Google Web Fonts](https://www.google.com/fonts#UsePlace:use/Collection:Merriweather:400,300,400italic,700,700italic), licensed under the [SIL Open Font License](http://scripts.sil.org/cms/scripts/page.php?item_id=OFL), and copyright [Sorkin Type Co](www.sorkintype.com) with Reserved Font Name 'Merriweather'.
 

README.md

@@ -27,6 +27,9 @@ Over the next few weeks, we will begin the *discovery sprint* for code.gov. Duri
 
 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).
+
 ## Contributing
 
 Here’s how you can help contribute to code.gov:

about.yml

@@ -62,7 +62,7 @@ team:
 - github: mattbailey0
   id: Matt Bailey
   role: Community Manager
-  
+
 # Partners for whom the project is developed
 partners:
 - OMB
@@ -106,11 +106,11 @@ licenses:
   ruby-on-rails:
     name: MIT
     url: https://github.com/rails/rails
- 
+
   jquery-1.11.3.min.js:
     name: MIT
     url: https://jquery.org/license/
-  font-awesome.min.css:
+  font-awesome:
     name: MIT, SIL OFL 1.1, CC BY 3.0
     url: http://fontawesome.io/license/
   ruby:

config/code-gov-config.json

@@ -0,0 +1,140 @@
+{
+  "title": "code.gov",
+  "api": {
+    "base": "https://api.code.gov/",
+    "key": "OC457325hyT6DpFm5HBBZ1i8SR6gtp5U2CdqtHZQ"
+  },
+  "style": "code-gov-style",
+  "twitter": {
+    "handle": "codedotgov"
+  },
+  "content": {
+    "home": {
+      "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"
+      },
+      "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": [
+        {
+          "title": "About Us",
+          "description": "Code.gov is on track to become the nation’s primary platform for sharing America’s code.  Find out how we’ll get there.",
+          "link": "/policy-guide/docs/overview/introduction",
+          "image": "../../../assets/img/icons/info_bl.png"
+        },
+        {
+          "title": "Policy Info",
+          "description": "The Federal Source Code Policy helps government agencies reduce duplicative software development and save taxpayer dollars.",
+          "link": "/policy-guide/policy/introduction",
+          "image": "../../../assets/img/icons/policy_bl.png"
+        },
+        {
+          "title": "Progress Report",
+          "description": "Government agencies are working hard to unlock the potential of code sharing and collaboration. Here’s a quick snapshot of their progress.",
+          "link": "/policy-guide/docs/compliance/dashboard",
+          "image": "../../../assets/img/icons/check_bl.png"
+        }
+      ],
+      "featured": [
+        {
+          "short_name": "WNTR",
+          "verbose_name": "Water Network Tool for Resilience",
+          "author": "Environmental Protection Agency",
+          "description": "A python package designed to simulate and analyze resilience of water distribution networks.",
+          "image": "/assets/img/featured-projects/pipes4.png",
+          "links": {
+            "view_project": "/#/explore-code/agencies/DOE/repos/doe_snl_water_network_tool_for_resilience_v_1_0",
+            "go_to_repo": "https://github.com/usepa/wntr"
+          }
+        },
+        {
+          "short_name": "ITS ODE",
+          "verbose_name": "Intelligent Transportation Systems Operational Data Environment",
+          "author": "Department of Transportation",
+          "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": {
+            "view_project": "/#/explore-code/agencies/DOT/repos/dot_fhwa_intelligent_transportation_systems_operational_data_environment_its_ode_",
+            "go_to_repo": "https://github.com/usdot-jpo-ode/jpo-ode"
+          }
+        },
+        {
+          "short_name": "WALKOFF",
+          "verbose_name": "",
+          "author": "National Security Agency",
+          "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": {
+            "view_project": "/#/explore-code/agencies/NSA/repos/nsa_walkoff",
+            "go_to_repo": "https://github.com/iadgov/WALKOFF"
+          }
+        }
+      ]
+    },
+    "footer": {
+      "links": [
+        {
+          "name": "Privacy Policy",
+          "url": "/#/privacy-policy"
+        },
+        {
+          "name": "Visit Project Page",
+          "url": "https://github.com/GSA/code-gov-web"
+        },
+        {
+          "name": "Join Mailing List",
+          "url": "https://bit.ly/2pnRlYN"
+        }
+      ],
+      "logos": [
+        {
+          "image": "/assets/img/logos/whitehouse.png",
+          "name": "The White House",
+          "url": "https://whitehouse.gov/"
+        },
+        {
+          "image": "/assets/img/logos/PIF.png",
+          "name": "Presidential Innovation Fellows",
+          "url": "https://presidentialinnovationfellows.gov/"
+        },
+        {
+          "image": "/assets/img/logos/GSA.png",
+          "name": "U.S. General Services Administration",
+          "url": "https://www.gsa.gov/"
+        }
+      ]
+    },
+    "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:code@gsa.gov'>Code@gsa.gov</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" }
+      ],
+      "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}
+      ],
+      "long": [
+        { "name": "User accounts", "status": null },
+        { "name": "Gamification", "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."
+    }
+  },
+  "images": {
+    "background": "./assets/img/american_flag_1920x1280_gradient.jpg"
+  }
+}

config/webpack.common.js

@@ -27,6 +27,7 @@ const NamedModulesPlugin = require('webpack/lib/NamedModulesPlugin');
 const PreloadWebpackPlugin = require('preload-webpack-plugin');
 const postcssCssnext = require('postcss-cssnext');
 const postcssImport = require('postcss-import');
+const SiteConfig = require('./code-gov-config.json');
 
 module.exports = function (options) {
 
@@ -53,7 +54,6 @@ module.exports = function (options) {
 
   const METADATA = {
     API_URL,
-    title: 'Code.gov',
     baseUrl: '/',
     isDevServer: helpers.isWebpackDevServer(),
     gtmAuth: isProd ? 'GTM-M9L9Q5' : 'GTM-MSJCVS',
@@ -78,6 +78,15 @@ module.exports = function (options) {
   /**
    * Common Plugins
    */
+
+  const htmlWebpackPlugin = new HtmlWebpackPlugin(Object.assign({
+      template: 'src/index.html',
+      chunksSortMode: 'dependency',
+      metadata: METADATA,
+      inject: 'head'
+    }, SiteConfig));
+  console.log("htmlWebpackPlugin:", htmlWebpackPlugin);
+
   const commonPlugins = [
     new AssetsPlugin({
       path: helpers.root('dist'),
@@ -157,14 +166,8 @@ module.exports = function (options) {
         'HMR': METADATA.HMR,
       }
     }),
-    new HtmlWebpackPlugin({
-      template: 'src/index.html',
-      title: METADATA.title,
-      chunksSortMode: 'dependency',
-      metadata: METADATA,
-      inject: 'head'
-    }),
-    new PreloadWebpackPlugin(),
+    htmlWebpackPlugin,
+    new PreloadWebpackPlugin()
   ];
 
   /**

config/webpack.federalist-deploy.js

@@ -18,6 +18,8 @@ const commonConfig = require('./webpack.common.js');
 const postcssCssnext = require('postcss-cssnext');
 const postcssImport = require('postcss-import');
 
+const SiteConfig = require('./code-gov-config.json');
+
 /**
  * Webpack Constants
  */
@@ -76,12 +78,18 @@ const METADATA = webpackMerge(webpackConfig.metadata, {
   gtmAuth: gtmAuth,
   HMR: false,
   isDevServer: false,
-  title: 'Code.gov'
 });
 
-
 module.exports = function (env) {
 
+  const htmlWebpackPlugin = new HtmlWebpackPlugin(Object.assign({
+    metadata: METADATA,
+    template: 'src/index.html',
+    chunksSortMode: 'dependency',
+    inject: 'head'
+  }, SiteConfig));
+ 
+
   return webpackMerge(webpackConfig({env: ENV}), {
 
     output: {
@@ -90,14 +98,9 @@ module.exports = function (env) {
 
     plugins: [
 
-      new HtmlWebpackPlugin({
-        metadata: METADATA,
-        template: 'src/index.html',
-        title: METADATA.title,
-        chunksSortMode: 'dependency',
-        inject: 'head'
-      }),
-      new PreloadWebpackPlugin(),
+     htmlWebpackPlugin,
+
+     new PreloadWebpackPlugin(),
 
       new LoaderOptionsPlugin({
         options: {

config/webpack.stag.js

@@ -23,6 +23,8 @@ const CriticalCssPlugin = require('./critical-css-plugin');
 const postcssCssnext = require('postcss-cssnext');
 const postcssImport = require('postcss-import');
 
+const SiteConfig = require('./code-gov-config.json');
+
 /**
  * Webpack Constants
  */
@@ -208,13 +210,12 @@ module.exports = function (env) {
       //   threshold: 2 * 1024
       // })
 
-      new HtmlWebpackPlugin({
+      new HtmlWebpackPlugin(Object.assign({
         template: 'src/index.html',
-        title: METADATA.title,
         chunksSortMode: 'dependency',
         metadata: METADATA,
         inject: 'head'
-      }),
+      }, SiteConfig)),
 
       /**
        * Inline critical-path CSS in index.html, and asynchronously load remainder of stylesheet.