Merge branch 'master' of https://github.com/department-of-veterans-af…

…fairs/vets-design-system-documentation

.gitignore

@@ -8,4 +8,5 @@ tmp_remote_assets
 fonts
 src/img
 src/_includes/react
-src/formation.min.css
+src/formation.min.css
+src/.jekyll-cache

Gemfile

@@ -8,7 +8,7 @@ source "https://rubygems.org"
 #
 # This will help ensure the proper Jekyll version is running.
 # Happy Jekylling!
-gem "jekyll", "~> 3.8.4"
+gem "jekyll", "~> 4.1.1"
 
 # This is the default theme for new Jekyll sites. You may change this to anything you like.
 gem "minima", "~> 2.0"

Gemfile.lock

@@ -1,74 +1,78 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     colorator (1.1.0)
-    concurrent-ruby (1.0.5)
-    em-websocket (0.5.1)
+    concurrent-ruby (1.1.7)
+    em-websocket (0.5.2)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
     eventmachine (1.2.7)
-    ffi (1.9.25)
+    ffi (1.13.1)
     forwardable-extended (2.6.0)
     http_parser.rb (0.6.0)
-    i18n (0.9.5)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    jekyll (3.8.4)
+    jekyll (4.1.1)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
-      i18n (~> 0.7)
-      jekyll-sass-converter (~> 1.0)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
       jekyll-watch (~> 2.0)
-      kramdown (~> 1.14)
+      kramdown (~> 2.1)
+      kramdown-parser-gfm (~> 1.0)
       liquid (~> 4.0)
-      mercenary (~> 0.3.3)
+      mercenary (~> 0.4.0)
       pathutil (~> 0.9)
-      rouge (>= 1.7, < 4)
+      rouge (~> 3.0)
       safe_yaml (~> 1.0)
-    jekyll-feed (0.11.0)
-      jekyll (~> 3.3)
-    jekyll-sass-converter (1.5.2)
-      sass (~> 3.4)
-    jekyll-seo-tag (2.5.0)
-      jekyll (~> 3.3)
-    jekyll-watch (2.1.1)
+      terminal-table (~> 1.8)
+    jekyll-feed (0.15.1)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-sass-converter (2.1.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-seo-tag (2.7.1)
+      jekyll (>= 3.8, < 5.0)
+    jekyll-watch (2.2.1)
       listen (~> 3.0)
-    kramdown (1.17.0)
-    liquid (4.0.1)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    mercenary (0.3.6)
-    minima (2.5.0)
-      jekyll (~> 3.5)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    minima (2.5.1)
+      jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
-    pathutil (0.16.1)
+    pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (3.0.3)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    rouge (3.3.0)
-    ruby_dep (1.5.0)
-    safe_yaml (1.0.4)
-    sass (3.6.0)
-      sass-listen (~> 4.0.0)
-    sass-listen (4.0.0)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
+    public_suffix (4.0.6)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.4)
+    rouge (3.24.0)
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  jekyll (~> 3.8.4)
+  jekyll (~> 4.1.1)
   jekyll-feed (~> 0.6)
   minima (~> 2.0)
   tzinfo-data
 
 BUNDLED WITH
-   1.16.6
+   1.17.2

README.md

@@ -3,6 +3,8 @@
 This is repo for the design system documentation, aka [design.va.gov](https://design.va.gov). If you are looking for the repo that contains the CSS and Javascript for the components, see the [formation package](https://github.com/department-of-veterans-affairs/veteran-facing-services-tools/tree/master/packages/formation) inside the [veteran-facing-services-tools repo](https://github.com/department-of-veterans-affairs/veteran-facing-services-tools).
 
 Min specs:
+- Ruby >= 2.4.0
+- RubyGems >= 2.7.0
 - [Jekyll](http://jekyllrb.com)
 - react
 - webpack
@@ -12,21 +14,23 @@ Min specs:
 Tested using `node` v8.12.0 and `npm` v6.4.1.
 
 1. Clone this repo
-```
-$ git clone https://github.com/department-of-veterans-affairs/vets-design-system-documentation.git
-```
+    ```
+    $ git clone https://github.com/department-of-veterans-affairs/vets-design-system-documentation.git
+    ```
 
-2. Install dependencies
-```
-$ npm install
-```
+1. Install NPM dependencies
+    ```
+    $ npm install
+    ```
 
-3. Build and start the Jekyll server
-```
-$ npm run start
-````
+1. [Install Jekyll](https://jekyllrb.com/docs/installation/)
 
-4. Verify in browser: [localhost:4000](http://localhost:4000/)
+1. Build and start the Jekyll server
+    ```
+    $ npm run start
+    ```
+
+1. Verify in browser: [localhost:4000](http://localhost:4000/)
 
 ## Adding content to the documentation site
 
@@ -51,32 +55,32 @@ In order to test new updates to Formation, you will need to work in two differen
 
 1. Clone the [veteran-facing-services-tools repo](https://github.com/department-of-veterans-affairs/veteran-facing-services-tools) at the same level as the design system documentation site.
 
-```
-my-projects-folder
-|   ├── vets-design-system-documentation
-|   ├── veteran-facing-services-tools
-```
+    ```
+    my-projects-folder
+    |   ├── vets-design-system-documentation
+    |   ├── veteran-facing-services-tools
+    ```
 
-2. Follow the [setup instructions](https://github.com/department-of-veterans-affairs/veteran-facing-services-tools#setup) to get `veteran-facing-services-tools` running.
+1. Follow the [setup instructions](https://github.com/department-of-veterans-affairs/veteran-facing-services-tools#setup) to get `veteran-facing-services-tools` running.
 
-3. Change `package.json` in `vets-design-system-documentation` to use a local version. `"@department-of-veterans-affairs/formation": "file:../veteran-facing-services-tools/packages/formation"`
+1. Change `package.json` in `vets-design-system-documentation` to use a local version. `"@department-of-veterans-affairs/formation": "file:../veteran-facing-services-tools/packages/formation"`
 
-4. Make your changes in `veteran-facing-services-tools` and run `$ npm run build`.
+1. Make your changes in `veteran-facing-services-tools` and run `$ npm run build`.
 
-5. Now, in `vets-design-system-documentation`, run the following:
+1. Now, in `vets-design-system-documentation`, run the following:
 
-  ```
-  $ npm install
-  $ npm run start
-  ```
+    ```
+    $ npm install
+    $ npm run start
+    ```
 
   While `vets-design-system-documentation` is running and make further updates to `veteran-facing-services-tools`, you will need to run `$ npm run build` in that repo, then `$ npm run build` in `vets-design-system-documentation`.
 
-6. When you have finished your work in `veteran-facing-services-tools`, follow the [instructions](https://github.com/department-of-veterans-affairs/veteran-facing-services-tools#publishing-module-to-npm) to submit a PR and publish to NPM.
+1. When you have finished your work in `veteran-facing-services-tools`, follow the [instructions](https://github.com/department-of-veterans-affairs/veteran-facing-services-tools#publishing-module-to-npm) to submit a PR and publish to NPM.
 
-7. Once your update has been published to NPM, update `package.json` in `vets-design-system-documentation` from the local version to the new version number.
+1. Once your update has been published to NPM, update `package.json` in `vets-design-system-documentation` from the local version to the new version number.
 
-8. Commit this along with any updates to the documentation site and submit a PR.
+1. Commit this along with any updates to the documentation site and submit a PR.
 
 ## Deploying
 

_config.yml

@@ -69,6 +69,4 @@ includes:
   - /components/code
 
 exclude:
-  - node_modules
   - tmp_remote_assets
-  - .sass-cache