From d54388bd6d27650a4b151ce32ce6223686752b86 Mon Sep 17 00:00:00 2001 From: Barb Denney Date: Wed, 13 Nov 2024 13:10:07 -0700 Subject: [PATCH 1/2] Update updating-this-site.md Added a section with guidance on how to edit multiple pages at once and how to preview your environment. --- src/_about/updating-this-site.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/src/_about/updating-this-site.md b/src/_about/updating-this-site.md index 4e1f1d3bc..47346c7dc 100644 --- a/src/_about/updating-this-site.md +++ b/src/_about/updating-this-site.md @@ -15,8 +15,16 @@ 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 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. + +Use the Preview pull request feature to share your changes with others before submitting ## 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). \ No newline at end of file +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). From 931a352c929858784a2f2f146343e94099895c5d Mon Sep 17 00:00:00 2001 From: Barb Denney Date: Wed, 13 Nov 2024 13:21:35 -0700 Subject: [PATCH 2/2] Update updating-this-site.md Fixed a typo. --- src/_about/updating-this-site.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/_about/updating-this-site.md b/src/_about/updating-this-site.md index 47346c7dc..9c98309f8 100644 --- a/src/_about/updating-this-site.md +++ b/src/_about/updating-this-site.md @@ -21,9 +21,7 @@ Watch [this tutorial](https://www.youtube.com/watch?v=kXwhzUg1lKA) if you need t ### 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 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. - -Use the Preview pull request feature to share your changes with others before submitting +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