docs: Fix docs (#20)

Author: Mielek

docs/DevEnvironmentSetup.md

@@ -56,5 +56,5 @@ From the repository root directory:
   ```
 * Run command to compile policies in the example project.
    ```shell
-   dotnet policy-compiler --s .\source\ --o .\target\ --format true
+   dotnet azure-apim-policy-compiler --s .\source\ --o .\target\ --format true
    ```

docs/IntegratePolicySolution.md

@@ -77,7 +77,7 @@ Because the Bicep file for deployment is in the `.\infrastructure\` folder, the
 `.\infrastructure\` as well. This will allow easy referencing of the policy documents in the bicep file.
 
 ```shell
-dotnet policy-compiler --s .\src\ --o .\infrastructure\
+dotnet azure-apim-policy-compiler --s .\src\ --o .\infrastructure\
 ```
 
 The command will produce the policy documents and the folder structure will look like this:
@@ -209,7 +209,7 @@ jobs:
       run: dotnet tool restore
 
     - name: Compile policy documents
-      run: dotnet policy-compiler --s .\src\ --o .\infrastructure\
+      run: dotnet azure-apim-policy-compiler --s .\src\ --o .\infrastructure\
 
     - name: Azure Login
       uses: azure/login@v2
@@ -277,7 +277,7 @@ steps:
   - script: dotnet tool restore
     displayName: 'Restore tools'
 
-  - script: dotnet policy-compiler --s .\src\ --o .\infrastructure\
+  - script: dotnet azure-apim-policy-compiler --s .\src\ --o .\infrastructure\
     displayName: 'Compile policy documents'
 
   - task: AzureCLI@2

docs/IntegratePolicySolutionWithApiOps.md

@@ -95,7 +95,7 @@ The compiler should target `artifacts` folder with APIOps data.
 An example of the command to run the compiler is below.
 
 ```shell
-dotnet policy-compiler --s .\policies\src\ --o .\artifacts\
+dotnet azure-apim-policy-compiler --s .\policies\src\ --o .\artifacts\
 ```
 
 After the command is executed the `artifacts` folder should contain all the policy files which can be easily published

docs/QuickStart.md

@@ -12,26 +12,40 @@ We will cover the following topics:
 
 ## Set up project for authoring policies
 
-* Check that you have latest [.NET SDK 8 sdk](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) version installed.
-* Open terminal and create a new solution by executing
+1. Check that you have latest [.NET SDK 8 sdk](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) version installed.
+2. Open terminal and create a new solution by executing
     ```shell
     dotnet new sln --output PolicySolution
     cd PolicySolution
     ```
-* Create a new class library project by executing
+3. Create a new class library project by executing
     ```shell
     dotnet new classlib --output Contoso.Apis.Policies
-    cd Contoso.Apis.Policies
+    dotnet sln add ./Contoso.Apis.Policies
     ```
-* Add Azure API Management policy toolkit library by running
+4. :exclamation: Azure API Management Policy toolkit is not yet published to NuGet.
+    Because of that, we need to create a local nuget repository for the packages and put the libraries there.
+   1. Create a local nuget repository for the packages by executing
+       ```shell
+       mkdir packages
+       ```
+   2. Download the Azure API Management policy toolkit libraries from GitHub release and put them in the `packages` folder.
+   3. Create a file named `nuget.config` in the solution folder with the content:
+       ```xml
+       <configuration>
+         <packageSources>
+           <!-- local feed for the project -->
+           <add key="local" value="./packages" />
+         </packageSources>
+       </configuration>
+       ```
+5. Add Azure API Management policy toolkit library by running
     ```shell
+    cd ./Contoso.Apis.Policies
     dotnet add package Azure.ApiManagement.PolicyToolkit.Authoring
     ```
 
-  | :exclamation: Azure API Management Policy toolkit is not yet published to NuGet. For now, please follow the repository setup guide to obtain packages mentioned in the document. |
-              |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-
-* Open the solution in your IDE of choice. We
+6. Open the solution in your IDE of choice. We
   tested [Visual Studio ](https://visualstudio.microsoft.com), [Raider](https://www.jetbrains.com/rider/), [Visual Studio Code](https://code.visualstudio.com/)
   with [C# Dev Kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit),
   but any IDE with C# support should work.
@@ -253,6 +267,7 @@ the following commands.
 
 ```shell
 dotnet new mstest --output Contoso.Apis.Policies.Tests
+dotnet sln add ./Contoso.Apis.Policies.Tests
 cd Contoso.Apis.Policies.Tests
 dotnet add package Azure.ApiManagement.PolicyToolkit.Testing
 dotnet add reference ..\Contoso.Apis.Policies
@@ -279,10 +294,10 @@ public class ApiOperationPolicyTest
     {
         var context = new MockExpressionContext();
         
-        context.MockRequest.IpAddress = "10.0.0.12";
+        context.Request.IpAddress = "10.0.0.12";
         Assert.IsTrue(ApiOperationPolicy.IsCompanyIP(context));
 
-        context.MockRequest.IpAddress = "11.0.0.1";
+        context.Request.IpAddress = "11.0.0.1";
         Assert.IsFalse(ApiOperationPolicy.IsCompanyIP(context));
     }
 }

docs/SolutionStructureRecommendation.md

@@ -46,7 +46,7 @@ documents as a flat structure. For example, the following command will compile t
 the `target` folder:
 
 ```shell
-dotnet policy-compiler --s .\src\ --o .\target\
+dotnet azure-apim-policy-compiler --s .\src\ --o .\target\
 ```
 
 Target folder after the compilation will look like this:
@@ -143,7 +143,7 @@ documents in the same structure as is present under `src` folder. For example, t
 policies and place them in the `target` folder:
 
 ```shell
-dotnet policy-compiler --s .\src\ --o .\target\
+dotnet azure-apim-policy-compiler --s .\src\ --o .\target\
 ```
 
 ```

example/.config/dotnet-tools.json

@@ -2,10 +2,10 @@
   "version": 1,
   "isRoot": true,
   "tools": {
-    "Azure.ApiManagement.policytoolkit.compiler": {
+    "Azure.ApiManagement.PolicyToolkit.Compiling": {
       "version": "0.0.1",
       "commands": [
-        "policy-compiler"
+        "azure-apim-policy-compiler"
       ]
     }
   }

example/ci-pipeline.cmd

@@ -1,4 +1,4 @@
 dotnet build || exit -1
 dotnet test || exit -2
-dotnet policy-compiler --s .\source\ --o .\target\ --format true || exit -3
+dotnet azure-apim-policy-compiler --s .\source\ --o .\target\ --format true || exit -3
 az deployment group create --resource-group YOUR_RESOURCE_GROUP --template-file .\deployment.bicep --parameters servicename=YOUR_SERVICE_NAME --name deploy-1 || exit -4