Skip to content

Commit 041d112

Browse files
author
Chris Valarida
authored
Merge pull request #475 from department-of-veterans-affairs/codespaces
initial codespaces config
2 parents 3efc4dd + 7f8f42b commit 041d112

File tree

2 files changed

+35
-23
lines changed

2 files changed

+35
-23
lines changed

.devcontainer/devcontainer.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"name": "vets-design-system-documentation",
3+
"postCreateCommand": "npm install && gem install jekyll && gem install bundler:1.16.6 && bundler install"
4+
}

README.md

+31-23
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
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).
44

55
Min specs:
6+
67
- [Jekyll](http://jekyllrb.com)
78
- react
89
- webpack
@@ -12,22 +13,31 @@ Min specs:
1213
Tested using `node` v8.12.0 and `npm` v6.4.1.
1314

1415
1. Clone this repo
15-
```
16-
$ git clone https://github.com/department-of-veterans-affairs/vets-design-system-documentation.git
17-
```
16+
17+
```
18+
$ git clone https://github.com/department-of-veterans-affairs/vets-design-system-documentation.git
19+
```
1820

1921
1. Install NPM dependencies
20-
```
21-
$ npm install
22-
```
22+
23+
```
24+
$ npm install
25+
```
2326

2427
1. [Install Jekyll](https://jekyllrb.com/docs/installation/)
25-
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 [email protected]` and make sure when you are adding references to your PATH that you specify version 2.6.6 instead of 3.0.0.
28+
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 [email protected]` and make sure when you are adding references to your PATH that you specify version 2.6.6 instead of 3.0.0.
29+
30+
1. Install Ruby gems
31+
32+
```
33+
$ bundle install
34+
```
2635

2736
1. Build and start the Jekyll server
28-
```
29-
$ npm run start
30-
```
37+
38+
```
39+
$ npm run start
40+
```
3141

3242
1. Verify in browser: [localhost:4000](http://localhost:4000/)
3343

@@ -44,22 +54,21 @@ To add content, you will need to look into `/src` directory. This will be the so
4454
- [Design patterns pages](https://github.com/department-of-veterans-affairs/vets-design-system-documentation/tree/master/src/_patterns)
4555
- [Utilities pages](https://github.com/department-of-veterans-affairs/vets-design-system-documentation/tree/master/src/_utilities)
4656

47-
4857
### How to add new pages, improve presentation, etc.
49-
[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.
5058

59+
[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.
5160

5261
## Testing updates to the Formation codebase on this site
5362

5463
In order to test new updates to Formation, you will need to work in two different repositories: the repository for this site and `veteran-facing-services-tools`. For the steps below, make sure you are doing your work in a new branch for both repos.
5564

5665
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.
5766

58-
```
59-
my-projects-folder
60-
| ├── vets-design-system-documentation
61-
| ├── veteran-facing-services-tools
62-
```
67+
```
68+
my-projects-folder
69+
| ├── vets-design-system-documentation
70+
| ├── veteran-facing-services-tools
71+
```
6372

6473
1. Follow the [setup instructions](https://github.com/department-of-veterans-affairs/veteran-facing-services-tools#setup) to get `veteran-facing-services-tools` running.
6574

@@ -69,12 +78,12 @@ In order to test new updates to Formation, you will need to work in two differen
6978

7079
1. Now, in `vets-design-system-documentation`, run the following:
7180

72-
```
73-
$ npm install
74-
$ npm run start
75-
```
81+
```
82+
$ npm install
83+
$ npm run start
84+
```
7685

77-
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`.
86+
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`.
7887

7988
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.
8089

@@ -85,4 +94,3 @@ In order to test new updates to Formation, you will need to work in two differen
8594
## Deploying
8695

8796
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.
88-

0 commit comments

Comments
 (0)