update temporary message

* Deploy to staging through CI * Replace individual .html pages with generated pages based on /_data/agencies.json (using jekyll-datapage-generator and _plugins/jekyll_page_generator.rb) * add /sitemap.xml * update to cflinuxfs4 on Cloud Foundry
18F · Jun 15, 2023 · b2dba68 · b2dba68
1 parent 0c1e9cf
commit b2dba68
Show file tree

Hide file tree

Showing 69 changed files with 1,796 additions and 6,948 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -42,5 +42,5 @@ jobs:
             sudo dpkg -i cf-cli_amd64.deb
             cf -v
       - run:
-          name: deploy site
+          name: deploy develop and master branches to cloud.gov
           command: bin/deploy-ci.sh
diff --git a/Gemfile b/Gemfile
@@ -7,3 +7,9 @@ gem 'bourbon', '~> 4.3.4'
 gem 'kramdown-parser-gfm'
 gem 'sass', '~> 3.4.24'
 gem 'neat', '~> 2.1.0'
+
+group :jekyll_plugins do
+    gem 'jekyll-datapage-generator'
+    gem 'jekyll-redirect-from'
+    gem 'jekyll-sitemap'
+end
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -30,8 +30,13 @@ GEM
       pathutil (~> 0.9)
       rouge (>= 1.7, < 4)
       safe_yaml (~> 1.0)
+    jekyll-datapage-generator (1.4.0)
+    jekyll-redirect-from (0.16.0)
+      jekyll (>= 3.3, < 5.0)
     jekyll-sass-converter (1.5.2)
       sass (~> 3.4)
+    jekyll-sitemap (1.4.0)
+      jekyll (>= 3.7, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
     kramdown (2.4.0)
@@ -64,6 +69,9 @@ PLATFORMS
 DEPENDENCIES
   bourbon (~> 4.3.4)
   jekyll (~> 3.9.0)
+  jekyll-datapage-generator
+  jekyll-redirect-from
+  jekyll-sitemap
   kramdown-parser-gfm
   neat (~> 2.1.0)
   sass (~> 3.4.24)

diff --git a/Makefile b/Makefile
@@ -21,10 +21,10 @@ dev-docker:
 	bundle exec jekyll serve --host 0.0.0.0 --watch --config=_config.yml,_development.yml
 
 deploy_production:
-	make production && cf push analytics
+	make production && cf v3-zdt-push analytics
 
 deploy_staging:
-	make staging && cf push analytics-staging
+	make staging && cf v3-zdt-push analytics-staging
 
 docker-start:
 	docker-compose up -d

diff --git a/README.md b/README.md
@@ -17,8 +17,8 @@ Other organizations who have reused this project for their analytics dashboard:
 | [The City of Omaha, NE](https://analytics.cityofomaha.org/)               | [The City of San Francisco, CA](http://analytics.sfgov.org/)                           |
 | [The City of Sacramento, CA](https://analytics.cityofsacramento.org/)     | [Carbarrus County, NC](http://analytics.cabarruscounty.us/)                            |
 | [Cook County, IL](http://opendocs.cookcountyil.gov/analytics/)            | [State of Kansas](https://analytics.kansas.gov/)                                       |
-| [City of Seattle](https://www.seattle.gov/about-our-digital-properties/web-analytics) | [Douglas County, NE](http://analytics.douglascounty-ne.gov/)               |        
-| [Washington State University](https://analytics.wsu.edu/)                 | [State of Indiana](https://analytics.in.gov/)                                          |      
+| [City of Seattle](https://www.seattle.gov/about-our-digital-properties/web-analytics) | [Douglas County, NE](http://analytics.douglascounty-ne.gov/)               |
+| [Washington State University](https://analytics.wsu.edu/)                 | [State of Indiana](https://analytics.in.gov/)                                          |
 | [The States of Jersey](http://webanalytics.gov.je/)                       | [The City of Pittsburgh](http://webstats.pittsburghpa.gov/)                            |
 | [U.S. Department of Education](http://www2.ed.gov/analytics)              | [U.S. Department of Veterans Affairs](http://www.oit.va.gov/analytics/)                |
 | [USA.gov - General Services Administration](https://www.usa.gov/website-analytics/) | [Government of Canada](https://gcanalyticsapp.com/gca-dashboard/dashboard-index) |
@@ -70,32 +70,12 @@ npm run build-dev
 ### Adding Additional Agencies
 
 1. Ensure that data is being collected for a specific agency's Google Analytics ID. Visit [18F's analytics-reporter](https://github.com/18F/analytics-reporter) for more information. Save the url path for the data collection path.
-1. Create a new html file in the `_agencies` directory. The name of the file will be the url path.
-    ```bash
-    touch _agencies/agencyx.html
-    ```
-1. Create a new html file in the `_data_pages` directory. Use the same name you used in step 2. This will be the data download page for this agency
-    ```bash
-    touch _data_pages/agencyx.html
-    ```
-1. Set the required data for for the new files. (Both files need this data.) example:
-    ```yaml
-    ---
-    name: Agency X # Name of the page
-    slug: agencyx # Same as the name of the html files. Used to generate data page links.
-    layout: default # type of layout used. available layouts are in `_layouts`
-    ---
-    ```
-1. Agency page: Below the data you just entered, include the page content you want. The `_agencies` page will use the `charts.html` partial and the `_data_pages` pages will use the `data_download.html` partial. example:
-    ```yaml
-    {% include charts.html %}
-    ```
+1. Create a new json object in the `/_data/agencies.json` file. The `slug` attribute of the object will be the url path. The `name` attribute is the Agency's name.
 
 ### Developing with local data
 
 The development settings assume data is available at `/fakedata`. You can change this in `_development.yml`.
 
-
 ### Developing with real live data from `analytics-reporter`
 
 If also working off of local data, e.g. using `analytics-reporter`, you will need to make the data available over HTTP _and_ through CORS.
@@ -133,6 +113,14 @@ The data will be available at `http://localhost:3000` over CORS, with no path pr
 
 ### Deploying the app
 
+Production and staging applications are deployed via CI automatically. Any
+commits to the `master` branch will be deployed to production after passing
+automated tests in CI. Any commits to the `develop` branch will be deployed to
+the staging application.
+
+It shouldn't be necessary to deploy manually, but with the Cloud Foundry CLI
+installed, follow these steps to deploy.
+
 To deploy to **analytics.usa.gov** after building the site with the details in `_config.yml`:
 
 ```bash

diff --git a/_agencies/agency-international-development.html b/_agencies/agency-international-development.html
diff --git a/_agencies/agriculture.html b/_agencies/agriculture.html
diff --git a/_agencies/commerce.html b/_agencies/commerce.html
diff --git a/_agencies/defense.html b/_agencies/defense.html
diff --git a/_agencies/education.html b/_agencies/education.html
diff --git a/_agencies/energy.html b/_agencies/energy.html
diff --git a/_agencies/environmental-protection-agency.html b/_agencies/environmental-protection-agency.html
diff --git a/_agencies/executive-office-president.html b/_agencies/executive-office-president.html
diff --git a/_agencies/general-services-administration.html b/_agencies/general-services-administration.html
diff --git a/_agencies/health-human-services.html b/_agencies/health-human-services.html
diff --git a/_agencies/homeland-security.html b/_agencies/homeland-security.html
diff --git a/_agencies/housing-urban-development.html b/_agencies/housing-urban-development.html
diff --git a/_agencies/interior.html b/_agencies/interior.html
diff --git a/_agencies/justice.html b/_agencies/justice.html
diff --git a/_agencies/labor.html b/_agencies/labor.html
diff --git a/_agencies/national-aeronautics-space-administration.html b/_agencies/national-aeronautics-space-administration.html
diff --git a/_agencies/national-archives-records-administration.html b/_agencies/national-archives-records-administration.html
diff --git a/_agencies/national-science-foundation.html b/_agencies/national-science-foundation.html
diff --git a/_agencies/nuclear-regulatory-commission.html b/_agencies/nuclear-regulatory-commission.html
diff --git a/_agencies/office-personnel-management.html b/_agencies/office-personnel-management.html
diff --git a/_agencies/postal-service.html b/_agencies/postal-service.html
diff --git a/_agencies/small-business-administration.html b/_agencies/small-business-administration.html
diff --git a/_agencies/social-security-administration.html b/_agencies/social-security-administration.html
diff --git a/_agencies/state.html b/_agencies/state.html
diff --git a/_agencies/transportation.html b/_agencies/transportation.html
diff --git a/_agencies/treasury.html b/_agencies/treasury.html
diff --git a/_agencies/veterans-affairs.html b/_agencies/veterans-affairs.html
diff --git a/_config.yml b/_config.yml
@@ -1,4 +1,6 @@
 
+baseurl: ""
+
 # Don't exclude nginx.conf, needs to be copied into _site for
 # cloud.gov to pick up on it.
 exclude:
@@ -23,6 +25,9 @@ exclude:
 - docker-compose.yml
 - bin/
 - docs/
+- fake-data/
+- node_modules/
+- spec/
 
 # defaults
 defaults:
@@ -33,14 +38,6 @@ defaults:
     values:
       layout: default
 
-collections:
-  agencies:
-    output: true
-    permalink: /:path/
-  data_pages:
-    output: true
-    permalink: /:path/data/
-
 # Site title and description
 title: "analytics.usa.gov | The US government's web traffic."
 description: "Official data on web traffic to hundreds of US federal government websites. Published by the Digital Analytics Program."
@@ -60,8 +57,33 @@ twitter: usgsa
 # Site wide error message
 site_wide_error:
   display: true
-  title: "Realtime data may not be accurate"
-  body: "The Google Analytics account that powers analytics.usa.gov is experiencing issues with realtime reporting. Realtime data may be inaccurate."
+  title: "Realtime data currently not available"
+  body: 'The Google Analytics account that powers analytics.usa.gov is in the process of migrating from Universal Analytics to GA4. Realtime data will become available post migration in the upcoming weeks. Stay tuned as we work hard to bring you the next generation GA4 data.<br><br>For immediate questions about your specific use case, please contact us at <a href="mailto:[email protected]">[email protected]</a>'
 sass:
   sass_dir: sass
   style: nested
+
+plugins:
+  - jekyll-datapage-generator
+  - jekyll-redirect-from
+
+page_gen:
+  # Write /agency.slug pages
+  - data: "agencies"
+    template: "data"
+    dir_expr: "record['slug']"
+    index_files: false
+    name_expr: "'index'"
+    title_expr: "record['name']"
+    # debug: true
+
+  # Write /agency.slug/data pages
+  - data: "agencies"
+    template: "data_download"
+    dir_expr: "record['slug'] + '/data/'"
+    index_files: false
+    # name: "index"
+    # name_expr: "record['slug']"
+    name_expr: "'index'"
+    title_expr: "record['name']"
+    debug: true