adds in md content for how to use codespaces

trussworks · Oct 4, 2023 · 1099945 · 1099945
1 parent 46a9071
commit 1099945
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/docs/codespace_pr_reviews.md b/docs/codespace_pr_reviews.md
@@ -0,0 +1,29 @@
+# Using Codesapces to review PRs without pulling a repo to your machine
+
+1. go to the PR
+2. click the `Code` button in the top right corner
+3. click the `Codespaces` tab
+4. `Create new codespace`
+
+   ![Create a new codespace screenshot](https://prod-files-secure.s3.us-west-2.amazonaws.com/bf5cb10c-8e7c-41db-97ca-ded0d1f001c9/49ab6248-8f67-4e79-9ee5-7dee09e03237/Untitled.png)
+
+5. **Wait** for the codespace to finish setting up, you should see stuff happening in the `Terminal`. If you mess with it before it is done it might not work. If you mess this up, yo might see an error about your node version.
+6. if the yarn install in that process was not successful, run `yarn install`. Wait until it is done before you do anything. takes ~5ish minutes
+7. if it is successful run `yarn storybook`
+8. You will get a message saying your application is running on port 9009. click the `Open in Browser` button
+
+   ![application running message](https://prod-files-secure.s3.us-west-2.amazonaws.com/bf5cb10c-8e7c-41db-97ca-ded0d1f001c9/1816a7df-3b12-4269-860f-8a1a1e616a65/Untitled.png)
+
+9. It should open a new tab that will have a blank window until the storybook is up and running. Might take a couple of minutes.
+10. It should show you the react uswds Storybook with the changes in the PR!
+
+    ![storybook running in codespaces dev environment](https://prod-files-secure.s3.us-west-2.amazonaws.com/bf5cb10c-8e7c-41db-97ca-ded0d1f001c9/02e9a1e8-ba30-4691-a37a-0d7def377db5/Untitled.png)
+
+11. proceed as if you were running the PR on your own machine. hooray!
+12. When your review is complete, you should delete the codespace. There are costs associated with storing codespaces. **You should therefore delete any codespaces you no longer need**.
+
+![how to delete the codespace screencap](https://prod-files-secure.s3.us-west-2.amazonaws.com/bf5cb10c-8e7c-41db-97ca-ded0d1f001c9/87a1d20d-6234-4a75-8498-f5dd89baadc9/Untitled.png)
+
+## Things to watch out for
+
+If you disrupt the installation process when you start the Codespace, it can mess up the node installation. If this happens, your best bet is to go back to the PR, open the codespaces menu, delete the codespace, and make a new one. This will not mess up the PR.