From 9eca9fd1b38a214b6af8daf84d6beb75a6493678 Mon Sep 17 00:00:00 2001 From: Amar Zavery Date: Mon, 14 Mar 2016 19:23:58 -0700 Subject: [PATCH] update Documentation --- Documentation/EnvironmentVariables.md | 2 +- Documentation/RunTests.md | 2 ++ Documentation/SetupRepo.md | 14 +++++++------- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/Documentation/EnvironmentVariables.md b/Documentation/EnvironmentVariables.md index 4ba7d4ece..20eedc9af 100644 --- a/Documentation/EnvironmentVariables.md +++ b/Documentation/EnvironmentVariables.md @@ -1,7 +1,7 @@ ## Environment Variables Setup -### For clients targeting the ARM (V2) Azure API following environment variables need to be setup +### For clients targeting the ARM (V2) Azure API that are generated using [AutoRest](https://github.com/Azure/autorest) should setup following environment variables: From an admin cmd console/terminal, at the root directory of your cloned repo, run the following for environment setup: * **Windows** ``` diff --git a/Documentation/RunTests.md b/Documentation/RunTests.md index 49ac1e138..ac277cc80 100644 --- a/Documentation/RunTests.md +++ b/Documentation/RunTests.md @@ -9,3 +9,5 @@ * Running selective tests: Comment out the unrequired tests in azure-sdk-for-node/test/testlist.txt file by putting "# " at the beginning of line and run the tests by executing: ```npm test``` + +* For running arm tests, execute `npm run unit-arm` diff --git a/Documentation/SetupRepo.md b/Documentation/SetupRepo.md index 24ff3d32d..0f21275a3 100644 --- a/Documentation/SetupRepo.md +++ b/Documentation/SetupRepo.md @@ -6,17 +6,17 @@ Setting up the Node SDK repo ``` git clone git@github.com:your-github-username/azure-sdk-for-node.git cd azure-sdk-for-node -git checkout dev +git checkout master git remote add upstream git@github.com:Azure/azure-sdk-for-node.git -git pull upstream dev -git push origin dev (if there are any updates) +git pull upstream master +git push origin master (if there are any updates) -Note: It is a best practice to create a separate branch for your feature from the dev branch. -In this way the dev branch in your fork can always be synced easily with upstream and is +Note: It is a best practice to create a separate branch for your feature from the master branch. +In this way the master branch in your fork can always be synced easily with upstream and is not polluted with your current changes. -git checkout -b mybranch -git push origin mybranch +git checkout -b myFeatureBranch +git push origin myFeatureBranch ``` * Installing the required npm modules from the root directory```npm install```