Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

initial codespaces config #475

Merged
merged 2 commits into from
Jun 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"name": "vets-design-system-documentation",
"postCreateCommand": "npm install && gem install jekyll && gem install bundler:1.16.6 && bundler install"
}
54 changes: 31 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 [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.
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.

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/)

Expand All @@ -44,22 +54,21 @@ 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

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.

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.

Expand All @@ -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.

Expand All @@ -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.