From 546e2f973e58c6ae14e1586e07c1c9f1e42184eb Mon Sep 17 00:00:00 2001 From: Therese <94404065+TKDickson@users.noreply.github.com> Date: Thu, 29 Aug 2024 14:10:12 -0500 Subject: [PATCH] Doc-Adding disclaimer to instructions while awaiting later ticket (#9511) --- .../docs/Operations/Updating the doc site/Gettingsetup.md | 2 ++ .../docs/Operations/Updating the doc site/how to update.md | 2 ++ .../docs/Operations/Updating the doc site/index.md | 4 +++- 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/VAMobile/documentation/docs/Operations/Updating the doc site/Gettingsetup.md b/VAMobile/documentation/docs/Operations/Updating the doc site/Gettingsetup.md index f2c5ae0e267..e3f25197fd4 100644 --- a/VAMobile/documentation/docs/Operations/Updating the doc site/Gettingsetup.md +++ b/VAMobile/documentation/docs/Operations/Updating the doc site/Gettingsetup.md @@ -5,6 +5,8 @@ sidebar_position: 1 # Setting up to update the VA Mobile doc site +_These instructions are for people who are comfortable with maintaining and troubleshooting setup on their local machine. If that's not you, please reach out to the QART tech lead for assistance._ + Before you can update the [VA Mobile documentation website](https://department-of-veterans-affairs.github.io/va-mobile-app/), you first need to download and set up a few different tools. You only need to do this once. Feel free to buddy up with someone for help with the initial setup! diff --git a/VAMobile/documentation/docs/Operations/Updating the doc site/how to update.md b/VAMobile/documentation/docs/Operations/Updating the doc site/how to update.md index 26b124a0136..85bd9186e38 100644 --- a/VAMobile/documentation/docs/Operations/Updating the doc site/how to update.md +++ b/VAMobile/documentation/docs/Operations/Updating the doc site/how to update.md @@ -5,6 +5,8 @@ sidebar_position: 2 # How to update the VA Mobile doc site +_These instructions are for people who are comfortable with maintaining and troubleshooting setup on their local machine. If that's not you, please reach out to the QART tech lead for assistance._ + Follow these steps each time you want to make an update to the [VA Mobile doc site](https://department-of-veterans-affairs.github.io/va-mobile-app/). You need: diff --git a/VAMobile/documentation/docs/Operations/Updating the doc site/index.md b/VAMobile/documentation/docs/Operations/Updating the doc site/index.md index 232dc5f2fcb..860fe080fa3 100644 --- a/VAMobile/documentation/docs/Operations/Updating the doc site/index.md +++ b/VAMobile/documentation/docs/Operations/Updating the doc site/index.md @@ -4,5 +4,7 @@ sidebar_position: 4 --- # Updating the doc site -This section covers all the steps necessary to initially get set up to update the VA Mobile documentation site [(Part 1)](how%20to%20update.md) as well as to update it each time after that [(Part 2)](Gettingsetup.md). +For people who are comfortable with maintaining and troubleshooting setup on their local machine, this section covers all the steps necessary to initially get set up to update the VA Mobile documentation site [(Part 1)](how%20to%20update.md) as well as to update it each time after that [(Part 2)](Gettingsetup.md). +For people who do not wish to maintain and troubleshoot a local setup, we will be adding instructions for how to update via Codespace when [ticket 9190](https://github.com/department-of-veterans-affairs/va-mobile-app/issues/9190) is completed. +In the meantime, if you need to update the doc site and are not an engineer, please reach out to the QART tech lead for assistance. \ No newline at end of file