From 0ff35402556690bf1df18b580cf0aaaa130be5db Mon Sep 17 00:00:00 2001 From: "Mike Chelen (he/him)" Date: Tue, 1 Jun 2021 18:15:34 +0000 Subject: [PATCH 1/2] add bundle install step --- README.md | 54 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 31 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 14129993f..f627e3cc1 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ 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: + - [Jekyll](http://jekyllrb.com) - react - webpack @@ -12,22 +13,31 @@ 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 + ``` 1. Install NPM dependencies - ``` - $ npm install - ``` + + ``` + $ npm install + ``` 1. [Install Jekyll](https://jekyllrb.com/docs/installation/) -NOTE: This repo works with Ruby version 2.6.6. Instead of using `brew install ruby`, which will install the latest version, run `brew install ruby@2.6` and make sure when you are adding references to your PATH that you specify version 2.6.6 instead of 3.0.0. + NOTE: This repo works with Ruby version 2.6.6. Instead of using `brew install ruby`, which will install the latest version, run `brew install ruby@2.6` and make sure when you are adding references to your PATH that you specify version 2.6.6 instead of 3.0.0. + +1. Install Ruby gems + + ``` + $ bundle install + ``` 1. Build and start the Jekyll server - ``` - $ npm run start - ``` + + ``` + $ npm run start + ``` 1. Verify in browser: [localhost:4000](http://localhost:4000/) @@ -44,10 +54,9 @@ To add content, you will need to look into `/src` directory. This will be the so - [Design patterns pages](https://github.com/department-of-veterans-affairs/vets-design-system-documentation/tree/master/src/_patterns) - [Utilities pages](https://github.com/department-of-veterans-affairs/vets-design-system-documentation/tree/master/src/_utilities) - ### How to add new pages, improve presentation, etc. -[Read the wiki](https://github.com/department-of-veterans-affairs/vets-design-system-documentation/wiki) to learn how to add new pages to design.va.gov, improve local search, add images, etc. +[Read the wiki](https://github.com/department-of-veterans-affairs/vets-design-system-documentation/wiki) to learn how to add new pages to design.va.gov, improve local search, add images, etc. ## Testing updates to the Formation codebase on this site @@ -55,11 +64,11 @@ 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 + ``` 1. Follow the [setup instructions](https://github.com/department-of-veterans-affairs/veteran-facing-services-tools#setup) to get `veteran-facing-services-tools` running. @@ -69,12 +78,12 @@ In order to test new updates to Formation, you will need to work in two differen 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`. +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`. 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. @@ -85,4 +94,3 @@ In order to test new updates to Formation, you will need to work in two differen ## Deploying Merges into `master` will automatically be deployed to `dev-design.va.gov`. Production is automatically deployed every weekday at 2pm. Deploys are executed by creating a release of vets-website via Jenkins. You can track the deployment in the Slack channel, #design-system. - From 7f8f42bc35d3a5ec7ef8c9e6e136912e59df456c Mon Sep 17 00:00:00 2001 From: "Mike Chelen (he/him)" Date: Tue, 1 Jun 2021 18:16:21 +0000 Subject: [PATCH 2/2] create initial devcontainer config --- .devcontainer/devcontainer.json | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 .devcontainer/devcontainer.json diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 000000000..10452a11e --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,4 @@ +{ + "name": "vets-design-system-documentation", + "postCreateCommand": "npm install && gem install jekyll && gem install bundler:1.16.6 && bundler install" +}