From b621507633f2d31698744c74e45b7a42f4e77dee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?McCoy=20Pati=C3=B1o?= <39780829+mccoyp@users.noreply.github.com> Date: Tue, 20 Jun 2023 14:59:34 -0700 Subject: [PATCH 1/2] Clarify technical docs in migration guide --- doc/dev/test_proxy_migration_guide.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/doc/dev/test_proxy_migration_guide.md b/doc/dev/test_proxy_migration_guide.md index ea3b9fc41333..a4f882d379f7 100644 --- a/doc/dev/test_proxy_migration_guide.md +++ b/doc/dev/test_proxy_migration_guide.md @@ -3,8 +3,8 @@ This guide describes the changes that service SDKs should make to their test frameworks in order to take advantage of the Azure SDK test proxy. -Documentation of the motivations and goals of the test proxy can be found [here][general_docs] in the azure-sdk-tools -GitHub repository, and documentation of how to set up and use the proxy can be found [here][detailed_docs]. +Documentation of test proxy's underlying functionality can be found [here][detailed_docs] in the `azure-sdk-tools` +GitHub repository, but this isn't necessary to read for Python testing. Please refer to the [troubleshooting guide][troubleshooting] if you have any issues migrating a package. @@ -466,8 +466,6 @@ client to the test. [env_var_loader]: https://github.com/Azure/azure-sdk-for-python/blob/main/tools/azure-sdk-tools/devtools_testutils/envvariable_loader.py -[general_docs]: https://github.com/Azure/azure-sdk-tools/blob/main/tools/test-proxy/Azure.Sdk.Tools.TestProxy/README.md - [mgmt_recorded_test_case]: https://github.com/Azure/azure-sdk-for-python/blob/main/tools/azure-sdk-tools/devtools_testutils/mgmt_recorded_testcase.py [parametrize]: https://docs.pytest.org/latest/example/parametrize.html From d0630f6bd632cad28ab0a4fdadcde7f7ca348c29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?McCoy=20Pati=C3=B1o?= <39780829+mccoyp@users.noreply.github.com> Date: Tue, 20 Jun 2023 15:00:59 -0700 Subject: [PATCH 2/2] Update troubleshooting guide --- doc/dev/test_proxy_troubleshooting.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/dev/test_proxy_troubleshooting.md b/doc/dev/test_proxy_troubleshooting.md index 5f748a46f8a9..95a4b9ee2b86 100644 --- a/doc/dev/test_proxy_troubleshooting.md +++ b/doc/dev/test_proxy_troubleshooting.md @@ -4,8 +4,8 @@ This guide details some common errors that can come up when migrating to and usi information about migrating existing tests to the test proxy, please refer to the [test proxy migration guide][migration_guide]. -Documentation of the motivations and goals of the test proxy can be found [here][general_docs] in the azure-sdk-tools -GitHub repository, and documentation of how to set up and use the proxy can be found [here][detailed_docs]. +Documentation of test proxy's underlying functionality can be found [here][detailed_docs] in the `azure-sdk-tools` +GitHub repository, but this isn't necessary to read for Python testing. ## Table of contents - [Guide for test proxy troubleshooting](#guide-for-test-proxy-troubleshooting) @@ -198,7 +198,6 @@ chmod +x .../azure-sdk-for-python/.proxy/Azure.Sdk.Tools.TestProxy [detailed_docs]: https://github.com/Azure/azure-sdk-tools/tree/main/tools/test-proxy/Azure.Sdk.Tools.TestProxy/README.md [env_var_loader]: https://github.com/Azure/azure-sdk-for-python/blob/main/tools/azure-sdk-tools/devtools_testutils/envvariable_loader.py [env_var_section]: https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/test_proxy_migration_guide.md#fetch-environment-variables -[general_docs]: https://github.com/Azure/azure-sdk-tools/blob/main/tools/test-proxy/documentation/test-proxy/initial-investigation.md [gitattributes]: https://git-scm.com/docs/gitattributes [mgmt_recorded_test_case]: https://github.com/Azure/azure-sdk-for-python/blob/main/tools/azure-sdk-tools/devtools_testutils/mgmt_recorded_testcase.py [migration_guide]: https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/test_proxy_migration_guide.md