Merge branch 'main' into 26b1dependabot/bundler/jekyll-open-sdg-plugi…

…ns-2.3.0

.github/workflows/build.yml

@@ -12,5 +12,11 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
       - name: Build
-        run: npm run build
+        run: |
+          npm install
+          npm run gulp
+          bundle exec jekyll build

.github/workflows/qa.yml

@@ -15,7 +15,14 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+      - name: USWDS
+        run: |
+          npm install
+          npm run gulp
       - name: Build static site
-        run: npm run build
+        run: bundle exec jekyll build
       - name: Test External Links
-        run: npm run qa
+        run: bundle exec htmlproofer --check-html _site

.gitignore

@@ -15,3 +15,6 @@ data/edges/
 data/headlines/
 data/json/
 vendor/*
+.vscode/*
+node_modules/*
+assets/uswds/*

.ruby-version

@@ -1 +1 @@
-2.7.7
+3.2.2

Gemfile

@@ -1,8 +1,9 @@
 source "https://rubygems.org"
 
-gem "jekyll", "~> 3.9", ">= 3.9.0"
-gem "html-proofer", "~> 3.19", ">= 3.19.2"
-gem "jekyll-remote-theme", ">= 0.4.3"
-gem "jekyll-open-sdg-plugins", "2.3.0"
-gem "jekyll-get-json", "~> 0.0.2"
-gem "kramdown-parser-gfm", "~> 1.1.0"
+gem "jekyll", "3.9.3"
+gem "html-proofer", "3.19.4"
+gem "jekyll-remote-theme"
+gem "deep_merge"
+gem 'jekyll-open-sdg-plugins', "2.3.0"
+gem "kramdown-parser-gfm"
+gem "webrick"

Gemfile.lock

@@ -4,7 +4,7 @@ GEM
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     colorator (1.1.0)
-    concurrent-ruby (1.2.3)
+    concurrent-ruby (1.3.4)
     deep_merge (1.2.2)
     ecma-re-validator (0.4.0)
       regexp_parser (~> 2.2)
@@ -26,13 +26,13 @@ GEM
       typhoeus (~> 1.3)
       yell (~> 2.0)
     http_parser.rb (0.8.0)
-    i18n (0.9.5)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
-    jekyll (3.9.2)
+    jekyll (3.9.3)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       jekyll-sass-converter (~> 1.0)
       jekyll-watch (~> 2.0)
       kramdown (>= 1.17, < 3)
@@ -41,9 +41,6 @@ GEM
       pathutil (~> 0.9)
       rouge (>= 1.7, < 4)
       safe_yaml (~> 1.0)
-    jekyll-get-json (0.0.2)
-      deep_merge (~> 1.2)
-      jekyll (>= 3.0)
     jekyll-open-sdg-plugins (2.3.0)
       deep_merge (~> 1.2)
       jekyll (~> 3.0)
@@ -107,6 +104,7 @@ GEM
       unf_ext
     unf_ext (0.0.9.1)
     uri_template (0.7.0)
+    webrick (1.8.2)
     yell (2.2.2)
 
 PLATFORMS
@@ -115,12 +113,13 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  html-proofer (~> 3.19, >= 3.19.2)
-  jekyll (~> 3.9, >= 3.9.0)
-  jekyll-get-json (~> 0.0.2)
+  deep_merge
+  html-proofer (= 3.19.4)
+  jekyll (= 3.9.3)
   jekyll-open-sdg-plugins (= 2.3.0)
-  jekyll-remote-theme (>= 0.4.3)
-  kramdown-parser-gfm (~> 1.1.0)
+  jekyll-remote-theme
+  kramdown-parser-gfm
+  webrick
 
 BUNDLED WITH
    2.4.2

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Office for National Statistics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,11 +1,21 @@
-[![GitHub Actions](https://github.com/GSA/sdg-indicators-usa/actions/workflows/build.yml/badge.svg)](https://github.com/GSA/sdg-indicators-usa/actions/workflows/build.yml)
-[![GitHub Actions](https://github.com/GSA/sdg-indicators-usa/actions/workflows/qa.yml/badge.svg)](https://github.com/GSA/sdg-indicators-usa/actions/workflows/qa.yml)
+# Open SDG - Site starter
 
-# Sustainable Development Goal indicators
+This is a starter repository to help in implementing the [Open SDG](https://github.com/open-sdg/open-sdg) platform. [See here for documentation](https://open-sdg.readthedocs.io).
 
-This is a development website for collecting and disseminating US data for the Sustainable Development Goal global indicators.
+### Requirements
+
+-   [Ruby](https://www.ruby-lang.org/en/) > 3.0
+-   [Bundler](https://bundler.io/) > 2.0
+
+# Usage
+| Command | Description |
+|---------|-------------|
+| `bundle install` | install the current dependencies |
+| `bundle exec jekyll build` | build the site. dumps to `_site` |
+| `bundle exec jekyll serve` | builds the site and serves it locally |
 
-For any guidance on how to use the website or develop it further for your own country, please refer to the [wiki](https://github.com/ONSdigital/sdg-indicators/wiki).
+### Publication 
+- the static sites created using this repo are configured to be published by pages.cloud.gov via webhooks. For more information on cloud.gov pages visit the [website](https://cloud.gov/pages/)
 
 ### Requirements
 
@@ -33,18 +43,6 @@ See [CONTRIBUTING](CONTRIBUTING.md) for additional information.
 
 This site is automatically published based on the branch.
 
-| Branch    | Environment | URL                                                   | Description                                                         |
-| --------- | ----------- | ----------------------------------------------------- | ------------------------------------------------------------------- |
-| `develop` | staging     | [sdg-staging.data.gov](https://sdg-staging.data.gov/) | Ad-hoc development and reviewing significant changes with partners. |
-| `main`    | production  | [sdg.data.gov](https://sdg.data.gov/)                 | Production instance of sdg.data.gov.                                |
-
-Federalist automatically builds previews for all branches. Changes to `main` are
-automatically published to [sdg.data.gov](https://sdg.data.gov/).
-Feature branches should be branched from `main`.
-
-`develop` is used ad-hoc in order to preview significant changes with partners
-and is not part of the development workflow.
-
 ## Public domain
 
 This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):