Skip to content

Commit

Permalink
Merge pull request #3517 from department-of-veterans-affairs/updating…
Browse files Browse the repository at this point in the history
…-this-site-updates

Update updating-this-site.md
  • Loading branch information
babsdenney authored Nov 18, 2024
2 parents e15f62a + 132a525 commit b956337
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions src/_about/updating-this-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,14 @@ The [wiki](https://github.com/department-of-veterans-affairs/vets-design-system-
- [New page templates](https://github.com/department-of-veterans-affairs/vets-design-system-documentation/wiki/Adding-content)
- [HTML snippets](https://github.com/department-of-veterans-affairs/vets-design-system-documentation/wiki/Writing-snippets) for enhanced content presentation

You can make updates directly in GitHub without any expertise in writing code as long as you write with markdown. When you are done with your work, create a new branch and submit a pull request.
You can make updates directly in GitHub without any expertise in writing code as long as you write with markdown. When you are done with your work, create a new branch and submit a pull request.

Watch [this tutorial](https://www.youtube.com/watch?v=kXwhzUg1lKA) if you need to make multiple changes at one time like adding an image to a page. If you try to add an image to a page directly in GitHub you would have to create two pull request. A better option would be to bundle the image and edits to the page into one pull request. An added benefit to bundling your changes is being able to preview all your changes in one place. Follow the instructions below for more information on previewing your pull request.

### Preview your changes

When making updates to documentation you can preview your changes before publishing them to the live site. When you create a pull request or a draft pull request, a preview link is created where you can view the entire documentation site with the changes that you submitted before publishing those changes to the live site. Follow [these instructions](https://github.com/department-of-veterans-affairs/vets-design-system-documentation?tab=readme-ov-file#previewing-pull-requests) or watch this [demo on YouTube (9:41)](https://youtu.be/kXwhzUg1lKA?feature=shared&t=581) to see the preview link in action.

## Updating CSS and this site

For instructions on how to update this site and while making changes to CSS, [see the README](https://github.com/department-of-veterans-affairs/vets-design-system-documentation#vets-design-system-documentation).
For instructions on how to update this site and while making changes to CSS, [see the README](https://github.com/department-of-veterans-affairs/vets-design-system-documentation#vets-design-system-documentation).

0 comments on commit b956337

Please sign in to comment.