Refreshing docs (#59)

dotnet · Jul 15, 2020 · 1d33ab1 · 1d33ab1
1 parent 841112f
commit 1d33ab1
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 27 deletions.
diff --git a/docs/benchmarking_docker.md b/docs/benchmarking_docker.md
@@ -15,7 +15,7 @@ It has a scenario called **netty** comprised of an _application_ job based on a
 
 ```yml
 imports:
-  - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Wrk/wrk.yml?token=AAI4T3NRKQTVLI2YOUJVCB2633AIM
+  - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Wrk/wrk.yml
 
 variables:
   localEndpoint: http://localhost:5010

diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -8,28 +8,17 @@ This tutorial shows how to benchmark a simple .NET web application using the __b
 2. Install Crank via the following command:
 
     ```text
-    > dotnet tool install -g Microsoft.Crank.Controller --version "0.1.0-*" 
+    dotnet tool install -g Microsoft.Crank.Controller --version "0.1.0-*" 
     ```
 
     ```text
-    > dotnet tool install -g Microsoft.Crank.Agent --version "0.1.0-*" 
-    ```
-
-    NB: Preview versions can be installed by running this command line:
-
-    ```text
-    > dotnet tool install -g Microsoft.Crank.Controller --version "0.1.0-*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json
-    ```
-    
-    ```text
-    > dotnet tool install -g Microsoft.Crank.Agent --version "0.1.0-*" --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json
+    dotnet tool install -g Microsoft.Crank.Agent --version "0.1.0-*" 
     ```
 
 3. Verify the installation was complete by running:
 
     ```
-    > crank
-    No jobs were found. Are you missing the --scenario argument?
+    crank
     ```
 
 ## Define the scenario
@@ -40,7 +29,7 @@ It contains the scenario definitions, describing which applications need to be d
 
 ```yml
 imports:
-    - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Bombardier/bombardier.yml?token=AAI4T3LCX6ET4DCTDLUVJX263U2AK
+    - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Bombardier/bombardier.yml
 
 jobs:
   server:

diff --git a/docs/local_application.md b/docs/local_application.md
@@ -61,7 +61,7 @@ public static void Main(string[] args)
 Execute the following command:
 
 ```
-> crank --config /crank/samples/hello/hello.benchmarks.yml --scenario hello --profile local
+crank --config /crank/samples/hello/hello.benchmarks.yml --scenario hello --profile local
 --application.options.displayOutput true
 ```
 

diff --git a/docs/reference/architecture.md b/docs/reference/architecture.md
@@ -12,12 +12,12 @@ Jobs are individual units of execution. A job can be encapsulated by a Dockerfil
 
 ```yaml
 imports:
-    - https://raw.githubusercontent.com/aspnet/Benchmarks/master/src/BombardierClient/bombardier.yml
+    - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Bombardier/bombardier.yml
 
 jobs:
   server:
     source:
-      repository: https://github.com/aspnet/perf
+      repository: https://github.com/dotnet/crank
       branchOrCommit: master
       project: samples/hello/hello.csproj
 

diff --git a/docs/storing_results.md b/docs/storing_results.md
@@ -11,7 +11,7 @@ Some jobs can provide more information when the results are stored than on the c
 The following example executes the __hello__ sample benchmark and stores the results in a file named `results.json`. We assume the agent is running locally.
 
 ```
-> crank --config /crank/samples/hello/hello.benchmarks.yml --scenario hello --profile local --output results.json 
+crank --config /crank/samples/hello/hello.benchmarks.yml --scenario hello --profile local --output results.json 
 ```
 
 And the file should contain some content similar to this:

diff --git a/samples/hello/hello.benchmarks.yml b/samples/hello/hello.benchmarks.yml
@@ -1,5 +1,5 @@
 imports:
-  - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Bombardier/bombardier.yml?token=AAI4T3I2FCYWGVT67SGEDVS643D3O
+  - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Bombardier/bombardier.yml
 
 jobs:
   server:

diff --git a/samples/local/local.benchmarks.yml b/samples/local/local.benchmarks.yml
@@ -1,5 +1,5 @@
 imports:
-  - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Bombardier/bombardier.yml?token=AAI4T3I2FCYWGVT67SGEDVS643D3O
+  - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Bombardier/bombardier.yml
 
 jobs:
   server:

diff --git a/samples/netty/netty.benchmarks.yml b/samples/netty/netty.benchmarks.yml
@@ -1,6 +1,5 @@
 imports:
-  #- https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Wrk/wrk.yml?token=AAI4T3NRKQTVLI2YOUJVCB2633AIM
-  - https://raw.githubusercontent.com/aspnet/Benchmarks/master/src/WrkClient/wrk.yml
+  - https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Jobs.Wrk/wrk.yml
 
 variables:
   localEndpoint: http://localhost:5010

diff --git a/src/Microsoft.Crank.Controller/Program.cs b/src/Microsoft.Crank.Controller/Program.cs
@@ -1216,7 +1216,7 @@ public static async Task<JObject> LoadConfigurationAsync(string configurationFil
                         if (!validationResults.IsValid)
                         {
                             // Create a json debug file with the schema
-                            localconfiguration.AddFirst(new JProperty("$schema", "https://raw.githubusercontent.com/aspnet/Benchmarks/master/src/BenchmarksDriver2/benchmarks.schema.json"));
+                            localconfiguration.AddFirst(new JProperty("$schema", "https://raw.githubusercontent.com/dotnet/crank/master/src/Microsoft.Crank.Controller/benchmarks.schema.json"));
 
                             var debugFilename = Path.Combine(Path.GetTempPath(), "crank-debug.json");
                             File.WriteAllText(debugFilename, localconfiguration.ToString(Formatting.Indented));

diff --git a/src/Microsoft.Crank.Controller/benchmarks.schema.json b/src/Microsoft.Crank.Controller/benchmarks.schema.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "http://microsoft.com/aspnet/benchmarks",
+  "$id": "http://microsoft.com/dotnet/crank",
   "type": "object",
   "title": ".NET Benchmarks Labs JSON Schema",
 
@@ -19,7 +19,7 @@
               "title": "The github repository containing the source.",
               "default": "",
               "examples": [
-                "https://github.com/aspnet/benchmarks.git"
+                "https://github.com/dotnet/crank.git"
               ],
               "pattern": "^(.*)$"
             },