combine frontend testing documentation pages (#4546)

Co-authored-by: Dhruv Bhanushali <hi@dhruvkb.dev>
Co-authored-by: zack <6351754+zackkrida@users.noreply.github.com>

Author: 3 people

.github/workflows/ci_cd.yml

@@ -825,7 +825,9 @@ jobs:
 
           It looks like some of the Playwright tests failed. You can download the trace output and image diffs for the failed tests under the "Artifacts" section in the above page.
 
-          You can read the [docs on how to use this artifact](https://docs.openverse.org/frontend/reference/playwright_tests.html#debugging).
+          You can read the [docs on how to use this artifact](https://docs.openverse.org/frontend/reference/testing_guidelines.html#debugging).
+
+          Additionally, if you made changes to the frontend UI, you may need to [update relevant playwright test snapshots](https://docs.openverse.org/frontend/guides/test.html#updating-snapshots).
 
           If the test is flaky, follow the [flaky test triage procedure](https://docs.openverse.org/general/test.html#flaky-tests).
           $EOF

documentation/conf.py

@@ -103,6 +103,8 @@ def add_ext_to_path():
     "meta/contribution/maintainer_tasks": "/general/contribution/maintainer_tasks.html",
     "meta/contribution/codespell": "/general/contribution/codespell.html",
     "meta/contribution/good_first_and_help_wanted_issues": "/general/contribution/good_first_and_help_wanted_issues.html",
+    "frontend/reference/playwright_tests.html": "/frontend/reference/testing_guidelines.html#playwright-tests",
+    "frontend/reference/storybook_tests.html": "/frontend/reference/testing_guidelines.html#storybook-tests",
 }
 
 myst_enable_extensions = ["linkify"]

documentation/frontend/guides/test.md

@@ -3,12 +3,9 @@
 Once you've made some changes to the codebase, it is important to run tests.
 Openverse uses unit tests, Playwright tests for end-to-end, and visual
 regression testing of the app and Storybook components. This guide will help you
-run the tests. To learn more about how to test PRs, read the
-[testing guidelines](/frontend/reference/testing_guidelines.md). To learn more
-about the Playwright tests, read
-[this guide](/frontend/reference/playwright_tests.md). To learn more about the
-Storybook visual regression tests, read
-[this guide](/frontend/reference/storybook_tests.md).
+run the tests. To learn more about how to test PRs, Playwright tests and
+Storybook visual regression tests read the
+[testing guidelines](/frontend/reference/testing_guidelines.md).
 
 ## Steps
 
@@ -44,6 +41,19 @@ Storybook visual regression tests, read
    ./ov just frontend/run test:storybook
    ```
 
+   ````{note}
+   This will run the Storybook visual regression tests inside a docker container. Should you wish to run the
+   tests locally, you can use the command below. However, please note that unless
+   you are running the same operating system (down to the distro, in some cases)
+   there are likely to be visual rendering differences that will cause snapshot
+   tests to fail on false-positives.
+
+   ```bash
+   ./ov just frontend/run test:storybook:local
+   ```
+
+   ````
+
 ## Updating snapshots
 
 If you've made changes to the frontend that require updating snapshots, you can

documentation/frontend/reference/index.md

@@ -6,8 +6,6 @@
 i18n
 feature_flags
 testing_guidelines
-playwright_tests
-storybook_tests
 miscellaneous
 healthcheck
 nginx