Regenerated documentation

FubarDevelopment · Jul 1, 2019 · d6f2e99 · d6f2e99
1 parent 541f11d
commit d6f2e99
Show file tree

Hide file tree

Showing 7 changed files with 59 additions and 49 deletions.
diff --git a/docs/articles/logging.html b/docs/articles/logging.html
@@ -104,7 +104,7 @@ <h2 id="configure-serilog-in-programcs">Configure serilog in Program.cs</h2>
 {
     class Program
     {
-        static async Task Main(string[] args)
+        static void Main(string[] args)
         {
             // Configure Serilog
             Log.Logger = new LoggerConfiguration()
@@ -140,13 +140,13 @@ <h2 id="configure-serilog-in-programcs">Configure serilog in Program.cs</h2>
                 var ftpServerHost = serviceProvider.GetRequiredService&lt;IFtpServerHost&gt;();
 
                 // Start the FTP server
-                await ftpServerHost.StartAsync();
+                ftpServerHost.StartAsync().Wait();
 
                 Console.WriteLine(&quot;Press ENTER/RETURN to close the test application.&quot;);
                 Console.ReadLine();
 
                 // Stop the FTP server
-                await ftpServerHost.StopAsync();
+                ftpServerHost.StopAsync().Wait();
             }
         }
     }
@@ -221,7 +221,7 @@ <h2 id="registering-nlog-in-programcs">Registering NLog in Program.cs</h2>
 {
     class Program
     {
-        static async Task Main()
+        static void Main(string[] args)
         {
             // Setup dependency injection
             var services = new ServiceCollection();
@@ -256,13 +256,13 @@ <h2 id="registering-nlog-in-programcs">Registering NLog in Program.cs</h2>
                 var ftpServerHost = serviceProvider.GetRequiredService&lt;IFtpServerHost&gt;();
 
                 // Start the FTP server
-                await ftpServerHost.StartAsync();
+                ftpServerHost.StartAsync().Wait();
 
                 Console.WriteLine(&quot;Press ENTER/RETURN to close the test application.&quot;);
                 Console.ReadLine();
 
                 // Stop the FTP server
-                await ftpServerHost.StopAsync();
+                ftpServerHost.StopAsync().Wait();
             }
         }
     }

diff --git a/docs/articles/quickstart-aspnetcore-host.html b/docs/articles/quickstart-aspnetcore-host.html
@@ -91,6 +91,11 @@ <h1 id="adding-the-nuget-packages">Adding the NuGet packages</h1>
 dotnet add package FubarDev.FtpServer.FileSystem.DotNet
 </code></pre>
 <h1 id="create-an-ihostedservice-implementation">Create an <code>IHostedService</code> implementation</h1>
+<div class="IMPORTANT">
+<h5>Important</h5>
+<p>This is only required for version 3.0, because the FTP server will
+provide a much tighter ASP.NET Core integration in a future release.</p>
+</div>
 <p>Create a new file named <code>HostedFtpService.cs</code>, which contains the following code:</p>
 <pre><code class="lang-cs" name="Program.cs" title="The wrapper for the hosted FTP server">using System.Threading;
 using System.Threading.Tasks;

diff --git a/docs/articles/quickstart-generic-host.html b/docs/articles/quickstart-generic-host.html
@@ -94,6 +94,11 @@ <h1 id="adding-the-nuget-packages">Adding the NuGet packages</h1>
 dotnet add package FubarDev.FtpServer.FileSystem.DotNet
 </code></pre>
 <h1 id="create-an-ihostedservice-implementation">Create an <code>IHostedService</code> implementation</h1>
+<div class="IMPORTANT">
+<h5>Important</h5>
+<p>This is only required for version 3.0, because the FTP server will
+provide a much tighter ASP.NET Core integration in a future release.</p>
+</div>
 <p>Create a new file named <code>HostedFtpService.cs</code>, which contains the following code:</p>
 <pre><code class="lang-cs" name="Program.cs" title="The wrapper for the hosted FTP server">using System.Threading;
 using System.Threading.Tasks;

diff --git a/docs/articles/quickstart.html b/docs/articles/quickstart.html
@@ -109,7 +109,7 @@ <h1 id="using-the-ftp-server">Using the FTP server</h1>
 {
     class Program
     {
-        static async Task Main(string[] args)
+        static void Main(string[] args)
         {
             // Setup dependency injection
             var services = new ServiceCollection();
@@ -135,13 +135,13 @@ <h1 id="using-the-ftp-server">Using the FTP server</h1>
                 var ftpServerHost = serviceProvider.GetRequiredService&lt;IFtpServerHost&gt;();
 
                 // Start the FTP server
-                await ftpServerHost.StartAsync();
+                ftpServerHost.StartAsync().Wait();
 
                 Console.WriteLine(&quot;Press ENTER/RETURN to close the test application.&quot;);
                 Console.ReadLine();
 
                 // Stop the FTP server
-                await ftpServerHost.StopAsync();
+                ftpServerHost.StopAsync().Wait();
             }
         }
     }

diff --git a/docs/index.html b/docs/index.html
@@ -106,13 +106,13 @@ <h2 id="what-does-it-look-like">What does it look like?</h2>
     var ftpServerHost = serviceProvider.GetRequiredService&lt;IFtpServerHost&gt;();
 
     // Start the FTP server
-    await ftpServerHost.StartAsync();
+    ftpServerHost.StartAsync().Wait();
 
     Console.WriteLine(&quot;Press ENTER/RETURN to close the test application.&quot;);
     Console.ReadLine();
 
     // Stop the FTP server
-    await ftpServerHost.StopAsync();
+    ftpServerHost.StopAsync().Wait();
 }
 </code></pre><h2 id="aspnet-core-integration">ASP.NET Core integration</h2>
 <p>You can also add the FTP server to your ASP.NET Core application by

diff --git a/docs/index.json b/docs/index.json
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -4218,7 +4218,7 @@
       "output": {
         ".html": {
           "relative_path": "articles/logging.html",
-          "hash": "BowAtF2haDmW8iOXQaVL6Q=="
+          "hash": "g6T+xTnC4zQ3pcVmJRj3hA=="
         }
       },
       "is_incremental": false,
@@ -4242,7 +4242,7 @@
       "output": {
         ".html": {
           "relative_path": "articles/quickstart-aspnetcore-host.html",
-          "hash": "2VaDlYqtkmYZJW2vdd8H6w=="
+          "hash": "2iWE8NWh0tyGAP+BI7IY/A=="
         }
       },
       "is_incremental": false,
@@ -4254,7 +4254,7 @@
       "output": {
         ".html": {
           "relative_path": "articles/quickstart-generic-host.html",
-          "hash": "3zlYF3cpOhTHYCfHN/4ptw=="
+          "hash": "tEbwooyK0VzW4TQPxNoDbw=="
         }
       },
       "is_incremental": false,
@@ -4266,7 +4266,7 @@
       "output": {
         ".html": {
           "relative_path": "articles/quickstart.html",
-          "hash": "zS7jAo+ki7eFYpIufjC9OQ=="
+          "hash": "c0kEn7+RR0cd1ygalZPlgQ=="
         }
       },
       "is_incremental": false,
@@ -4302,7 +4302,7 @@
       "output": {
         ".html": {
           "relative_path": "index.html",
-          "hash": "SmBbnywEtsTEPtXuy9DiaA=="
+          "hash": "ycpfc50ZOy8j8Mf980ahIQ=="
         }
       },
       "is_incremental": false,
@@ -4330,13 +4330,6 @@
         "skipped_file_count": 0
       },
       "processors": {
-        "TocDocumentProcessor": {
-          "can_incremental": false,
-          "details": "Processor TocDocumentProcessor cannot support incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.",
-          "incrementalPhase": "build",
-          "total_file_count": 0,
-          "skipped_file_count": 0
-        },
         "ManagedReferenceDocumentProcessor": {
           "can_incremental": true,
           "incrementalPhase": "build",
@@ -4347,7 +4340,14 @@
           "can_incremental": true,
           "incrementalPhase": "build",
           "total_file_count": 16,
-          "skipped_file_count": 15
+          "skipped_file_count": 14
+        },
+        "TocDocumentProcessor": {
+          "can_incremental": false,
+          "details": "Processor TocDocumentProcessor cannot support incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.",
+          "incrementalPhase": "build",
+          "total_file_count": 0,
+          "skipped_file_count": 0
         }
       }
     },