You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+31-23
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,7 @@
3
3
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).
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
+
```
26
35
27
36
1. Build and start the Jekyll server
28
-
```
29
-
$ npm run start
30
-
```
37
+
38
+
```
39
+
$ npm run start
40
+
```
31
41
32
42
1. Verify in browser: [localhost:4000](http://localhost:4000/)
33
43
@@ -44,22 +54,21 @@ To add content, you will need to look into `/src` directory. This will be the so
### 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.
50
58
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.
51
60
52
61
## Testing updates to the Formation codebase on this site
53
62
54
63
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.
55
64
56
65
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.
57
66
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
+
```
63
72
64
73
1. Follow the [setup instructions](https://github.com/department-of-veterans-affairs/veteran-facing-services-tools#setup) to get `veteran-facing-services-tools` running.
65
74
@@ -69,12 +78,12 @@ In order to test new updates to Formation, you will need to work in two differen
69
78
70
79
1. Now, in `vets-design-system-documentation`, run the following:
71
80
72
-
```
73
-
$ npm install
74
-
$ npm run start
75
-
```
81
+
```
82
+
$ npm install
83
+
$ npm run start
84
+
```
76
85
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`.
78
87
79
88
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.
80
89
@@ -85,4 +94,3 @@ In order to test new updates to Formation, you will need to work in two differen
85
94
## Deploying
86
95
87
96
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.
0 commit comments