Update help text, fleshout docs, add scheduler scripts

Author: ethanhann

docs-src/commands.md

@@ -65,6 +65,7 @@ namespace MyCommandPlugin
 }
 ```
 
+
 ## Run a Command
 
 Create a class that implements **InEngine.Core.IOptions** in the same assembly as the command class.
@@ -102,7 +103,7 @@ Run your command...
 InEngineCli.exe -pMyCommandPlugin my-command
 ```
 
-## Discover Commands Plugins
+## Discover Command Plugins
 
 Run InEngineCli.exe without any arguments to see a list of arguments.
 
@@ -121,10 +122,10 @@ InEngineCli.exe -pInEngine.Core
 ```
 
 The **InEngine.Core** library is itself a plugin that contains queue related commands. 
-This is the help output for the core plugin.
+As an example, this is the help output for the core plugin.
 
 ```text
-InEngine 3.1.0
+InEngine 3.x
 Copyright © Ethan Hann 2017
 
   queue:publish    Publish a command message to a queue.
@@ -148,11 +149,87 @@ InEngineCli.exe -pInEngine.Core queue:clear -h
 The **InEngine.Core** plugin's command to clear the InEngine.NET's queues produces this help message. 
 
 ```text
-InEngine 3.1.0
+InEngine 3.x
 Copyright © Ethan Hann 2017
 
   --processing-queue    Clear the processing queue.
 
   --secondary           Clear the secondary queue.
 ```
 
+
+## Logging
+
+The **InEngine.Core.AbstractCommand** class provides a Logger property. It implements the **NLog.ILogger** interface.
+
+```csharp
+using System;
+using InEngine.Core;
+
+namespace MyCommandPlugin
+{
+    public class MyCommand : ICommand
+    {
+        public override CommandResult Run()
+        {
+            Logger.Trace("Sample trace message");
+            Logger.Debug("Sample debug message");
+            Logger.Info("Sample informational message");
+            Logger.Warn("Sample warning message");
+            Logger.Error("Sample error message");
+            Logger.Fatal("Sample fatal error message");
+            return new CommandResult(true);
+        }
+    }
+}
+```
+
+Setup an [NLog configuration](https://github.com/NLog/NLog/wiki/Tutorial#configuration) file, something like this...
+
+```xml
+<?xml version="1.0" encoding="utf-8" ?>
+<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+
+    <targets>
+        <target name="logfile" xsi:type="File" fileName="file.txt" />
+        <target name="console" xsi:type="Console" />
+    </targets>
+
+    <rules>
+        <logger name="*" minlevel="Trace" writeTo="logfile" />
+        <logger name="*" minlevel="Info" writeTo="console" />
+    </rules>
+</nlog>
+```
+
+## Progress Bar
+
+The **InEngine.Core.AbstractCommand** class provides a ProgressBar property. This is how it is used.
+
+```csharp
+using InEngine.Core;
+
+namespace MyCommandPlugin
+{
+    public class MyCommand : AbstractCommand
+    {
+        public override CommandResult Run()
+        {
+            // Define the ticks (aka steps) for the command...
+            var maxTicks = 100000;
+            SetProgressBarMaxTicks(maxTicks);
+
+            // Do some work...
+            for (var i = 0; i <= maxTicks;i++)
+            {
+                // Update the command's progress
+                UpdateProgress(i);
+            }
+
+            return new CommandResult(true);
+        }
+    }
+}
+```
+ 

docs-src/css/style.css

@@ -1,16 +1,16 @@
 .navbar-default {
-    background: #2f2f2f;
+    background: #0a69fa;
 }
 
 .navbar-default .navbar-nav > .active > a,
 .navbar-default .navbar-nav > .active > a:hover,
 .navbar-default .navbar-nav > .active > a:focus {
-    background-color: #0f0f0f;
+    background-color: #0a69fa;
 }
 
 .navbar-default .navbar-nav > li > a:hover,
 .navbar-default .navbar-nav > li > a:focus {
-    background-color: #0f0f0f;
+    background-color: #0a69fa;
 }
 
 a,

docs-src/scheduling.md

@@ -0,0 +1,81 @@
+# Scheduling
+
+[Commands](commands) can be scheduled to run by leveraging the InEngineScheduler.exe program, available as a download from a recent [release](https://github.com/InEngine-NET/InEngine.NET/releases).
+
+## Manually Running the Scheduler
+
+Running the scheduler from the CommandLine is useful for debugging or local development. Simply run *InEngineScheduler.exe* from the command line.
+
+```bash
+InEngineScheduler.exe
+```
+
+It can also be run on Mac/Linux with Mono.
+
+```bash
+mono InEngineScheduler.exe
+``` 
+
+## Running as a Windows Service
+
+
+### Installing as a Windows Service
+Run the Install.ps1 PowerShell script in the scheduler directory to install the scheduler in place. The script needs to be run as an administrator. The script will register the service at the location where the script is run. 
+
+```bash
+ps Install.ps1
+```
+
+### Uninstalling the Windows Service
+
+Simply run the **Uninstall.ps1** script with elevated permissions to unregister the service.
+
+```bash
+ps Uninstall.ps1
+```
+
+## Running with Supervisor (on Linux)
+
+Supervisor is a process control system for Linux. It has extensive [documentation](http://supervisord.org/index.html), but the following should be enough to get started.
+
+### Installing Supervisor
+
+This command installs Supervisor on Ubuntu:
+
+```
+sudo apt-get install supervisor
+```
+
+### Configuring Supervisor
+
+Supervisor configuration files are stored in the **/etc/supervisor/conf.d** directory. Multiple files can be created in this directory to specify different programs, or multiple instances of the same program, for Supervisor to monitor. Copy this sample config into a file called **/etc/supervisor/conf.d/inengine-scheduler.conf**. 
+
+```ini
+[program:inengine-scheudler]
+process_name=%(program_name)s_%(process_num)02d
+directory=/path/to/scheduler
+command=mono InEngineScheduler.exe
+autostart=true
+autorestart=true
+user=InEngine
+numprocs=1
+redirect_stderr=true
+stdout_logfile=./scheduler.log
+```
+
+### Starting Supervisor
+
+Whenever a configuration change happens to files in the Supervisor config files, Supervisor needs to be instructed to reload its configuration.
+
+```bash
+sudo supervisorctl reread
+sudo supervisorctl update
+```
+
+Now, simply start the InEngine Scheduler.
+
+```bash
+sudo supervisorctl start inengine-scheduler:*
+```
+
+

mkdocs.yml

@@ -7,8 +7,9 @@ copyright: © 2017 - Ethan Hann
 
 pages:
 - Getting Started: 'index.md'
-- commands.md
+- Documentation:
+  - commands.md
+  - scheduling.md
 
 extra_css:
     - css/style.css
-

src/InEngine.Core/AbstractCommand.cs

@@ -7,7 +7,7 @@ namespace InEngine.Core
     abstract public class AbstractCommand : ICommand, IJob
     {
         public IJobExecutionContext JobExecutionContext { get; set; }
-        public Logger Logger { get; internal set; }
+        public ILogger Logger { get; internal set; }
         public ProgressBar ProgressBar { get; internal set; }
         string _name;
         public string Name

src/InEngine.Core/Queue/Commands/Consume.cs

@@ -5,10 +5,10 @@ namespace InEngine.Core.Queue.Commands
 {
     public class Consume : AbstractCommand
     {
-        [Option("all", DefaultValue = false)]
+        [Option("all", HelpText = "Consume all the messages in the primary or secondary queue.")]
         public bool ShouldConsumeAll { get; set; }
 
-        [Option("secondary", DefaultValue = false, HelpText = "Consume from a secondary queue.")]
+        [Option("secondary", DefaultValue = false, HelpText = "Consume from the secondary queue.")]
         public bool UseSecondaryQueue { get; set; }
 
         public override CommandResult Run()

src/InEngine.Core/Queue/Commands/GetLength.cs

@@ -5,9 +5,6 @@ namespace InEngine.Core.Queue.Commands
 {
     public class GetLength : AbstractCommand
     {
-        [Option("processing-queue", HelpText = "Display the number of command actively running.")]
-        public bool CheckProcessingQueue { get; set; }
-
         public override CommandResult Run()
         {
             var broker = Broker.Make();

src/InEngine.Core/Queue/Commands/Null.cs

@@ -1,6 +1,8 @@
-using System;
-namespace InEngine.Core.Queue.Commands
+namespace InEngine.Core.Queue.Commands
 {
+    /// <summary>
+    /// Dummy command for testing and sample code.
+    /// </summary>
     public class Null : AbstractCommand
     {
         public override CommandResult Run()

src/InEngine.Core/Queue/Commands/Publish.cs

@@ -1,6 +1,4 @@
-using System.IO;
-using System.Linq;
-using System.Reflection;
+using System.Linq;
 using CommandLine;
 
 namespace InEngine.Core.Queue.Commands

src/InEngineScheduler/InEngineScheduler.csproj

@@ -63,6 +63,10 @@
     <None Include="appsettings.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Include="Install.ps1">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Include="Uninstall.ps1" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\InEngine.Core\InEngine.Core.csproj">