Skip to content

Commit

Permalink
Merge pull request #3465 from department-of-veterans-affairs/preview-…
Browse files Browse the repository at this point in the history
…readme-images

Update preview images in README so they work
  • Loading branch information
jamigibbs authored Oct 30, 2024
2 parents 4181d06 + a30071a commit d04aaf7
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,17 +96,19 @@ Merges into `main` will automatically deploy to production `design.va.gov` after

### Previewing Pull Requests

When a PR is created, a preview of those changes will be available after the [Preview workflow](https://github.com/department-of-veterans-affairs/vets-design-system-documentation/blob/main/.github/workflows/preview.yml) has completed. There will be a "View deployment" button visible that will launch the preview environment when clicked.
When a PR is created, a preview of those changes will be available after the [Preview workflow](https://github.com/department-of-veterans-affairs/vets-design-system-documentation/blob/main/.github/workflows/preview.yml) has completed. There will be a "View deployment" button visible that will launch the preview environment when clicked:

[The "view deployment" button on a pull request](src/images/readme/pr-view-deployment-button.png)
![The "view deployment" button on a pull request](https://github.com/department-of-veterans-affairs/vets-design-system-documentation/blob/main/src/images/readme/pr-view-deployment-button.png?raw=true)

The preview link can also be accessed directly using this pattern: `https://dev-design.va.gov/PR_NUMBER`. For example, `https://dev-design.va.gov/3435` where `3435` is the unique PR number visible in the PR title.

If the preview has stopped working (for example if you're only seeing a 403 Forbidden error or similar), re-run the preview workflow by clicking "Details" next to the Preview check and then click the "Re-run all jobs" button.
If the preview has stopped working (for example if you're only seeing a 403 Forbidden error or similar), re-run the preview workflow by clicking "Details" next to the Preview check:

[A list of PR checks with an arrow pointing to the details link for the Preview workflow](src/images/readme/pr-checks-preview-details.png)
![A list of PR checks with an arrow pointing to the details link for the Preview workflow](https://raw.githubusercontent.com/department-of-veterans-affairs/vets-design-system-documentation/refs/heads/main/src/images/readme/pr-checks-preview-details.png)

[The "Re-run all jobs" button for running a Github workflow again](src/images/readme/re-run-workflow-button.png)
Then click the "Re-run all jobs" button at the top of the page:

![The "Re-run all jobs" button for running a Github workflow again](https://github.com/department-of-veterans-affairs/vets-design-system-documentation/blob/main/src/images/readme/re-run-workflow-button.png?raw=true)

## Additional Testing

Expand Down

0 comments on commit d04aaf7

Please sign in to comment.