Skip to content

Commit 93aad21

Browse files
committed
Update docs
1 parent 4154b07 commit 93aad21

File tree

3 files changed

+4
-7
lines changed

3 files changed

+4
-7
lines changed

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,5 +146,5 @@ <h4 class="modal-title" id="exampleModalLabel">Search</h4>
146146

147147
<!--
148148
MkDocs version : 0.16.3
149-
Build Date UTC : 2017-11-21 14:08:10
149+
Build Date UTC : 2017-11-21 14:09:52
150150
-->

docs/mkdocs/search_index.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
},
6363
{
6464
"location": "/scheduling/",
65-
"text": "Scheduling\n\n\nCommands\n can be scheduled to run by leveraging the InEngineScheduler.exe program, available as a download from a recent \nrelease\n.\n\n\nScheduling a Command\n\n\nA job schedule is created by adding a class to your plugin assembly that implements the \nInEngine.Core.Jobs\n interface.\n\n\n\nusing System;\nusing Quartz;\n\nnamespace MyCommandPlugin\n{\n public class Jobs : IJobs\n {\n public void Schedule(IScheduler scheduler)\n {\n // Schedule some jobs\n }\n }\n}\n\n\n\n\nThis class is automatically discovered by the InEngine.NET scheduler.\nIt will call the Jobs.Schedule method with an initialized Quartz.NET scheduler object.\n\n\nusing System;\nusing Quartz;\nusing InEngine.Core.Queue.Commands;\nusing System.Collections.Generic;\nusing System.Linq;\n\nnamespace InEngine.Core.Queue\n{\n public class Jobs : IJobs\n {\n public void Schedule(IScheduler scheduler)\n {\n var myCommand = new MyCommand();\n\n // Generate a schedulable job with the command\n var job = myCommand.MakeTriggerBuilder().Build();\n\n // Generate a trigger for the job, and set its schedule to every 10 seconds.\n var trigger = myCommand.MakeTriggerBuilder().Build()\n .StartNow()\n .WithSimpleSchedule(x =\n x.WithIntervalInSeconds(10).RepeatForever())\n .Build();\n\n // Register the job and trigger with the scheduler\n scheduler.ScheduleJob(job, trigger);\n }\n }\n}\n\n\n\n\n\nRunning the Scheduler\n\n\nManually from the CLI\n\n\nRunning the scheduler from the CommandLine is useful for debugging or local development. Simply run \nInEngineScheduler.exe\n from the command line.\n\n\nInEngineScheduler.exe\n\n\n\n\nIt can also be run on Mac/Linux with Mono.\n\n\nmono InEngineScheduler.exe\n\n\n\n\nOn Windows as a Service\n\n\nInstalling\n\n\nRun 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. \n\n\nps Install.ps1\n\n\n\n\nUninstalling\n\n\nSimply run the \nUninstall.ps1\n script with elevated permissions to unregister the service.\n\n\nps Uninstall.ps1\n\n\n\n\nOn Linux with Supervisor\n\n\nSupervisor is a process control system for Linux. It has extensive \ndocumentation\n, but the following should be enough to get started.\n\n\nInstalling Supervisor\n\n\nThis command installs Supervisor on Ubuntu:\n\n\nsudo apt-get install supervisor\n\n\n\n\nConfiguring Supervisor\n\n\nSupervisor configuration files are stored in the \n/etc/supervisor/conf.d\n 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 \n/etc/supervisor/conf.d/inengine-scheduler.conf\n. \n\n\n[program:inengine-scheudler]\nprocess_name=%(program_name)s_%(process_num)02d\ndirectory=/path/to/scheduler\ncommand=mono InEngineScheduler.exe\nautostart=true\nautorestart=true\nuser=InEngine\nnumprocs=1\nredirect_stderr=true\nstdout_logfile=./scheduler.log\n\n\n\n\nStarting Supervisor\n\n\nWhenever a configuration change happens to files in the Supervisor config files, Supervisor needs to be instructed to reload its configuration.\n\n\nsudo supervisorctl reread\nsudo supervisorctl update\n\n\n\n\nNow, simply start the InEngine Scheduler.\n\n\nsudo supervisorctl start inengine-scheduler:*",
65+
"text": "Scheduling\n\n\nCommands\n can be scheduled to run by leveraging the InEngineScheduler.exe program, available as a download from a recent \nrelease\n.\n\n\nScheduling a Command\n\n\nA job schedule is created by adding a class to your plugin assembly that implements the \nInEngine.Core.Jobs\n interface.\n\n\n\nusing System;\nusing Quartz;\n\nnamespace MyCommandPlugin\n{\n public class Jobs : IJobs\n {\n public void Schedule(IScheduler scheduler)\n {\n // Schedule some jobs\n }\n }\n}\n\n\n\n\nThis class is automatically discovered by the InEngine.NET scheduler.\nIt will call the Jobs.Schedule method with an initialized Quartz.NET scheduler object.\n\n\nusing System;\nusing Quartz;\n\nnamespace MyCommandPlugin\n{\n public class Jobs : IJobs\n {\n public void Schedule(IScheduler scheduler)\n {\n var myCommand = new MyCommand();\n\n // Generate a schedulable job with the command\n var job = myCommand.MakeTriggerBuilder().Build();\n\n // Generate a trigger for the job, and set its schedule to every 10 seconds.\n var trigger = myCommand.MakeTriggerBuilder().Build()\n .StartNow()\n .WithSimpleSchedule(x =\n x.WithIntervalInSeconds(10).RepeatForever())\n .Build();\n\n // Register the job and trigger with the scheduler\n scheduler.ScheduleJob(job, trigger);\n }\n }\n}\n\n\n\n\n\nRunning the Scheduler\n\n\nManually from the CLI\n\n\nRunning the scheduler from the CommandLine is useful for debugging or local development. Simply run \nInEngineScheduler.exe\n from the command line.\n\n\nInEngineScheduler.exe\n\n\n\n\nIt can also be run on Mac/Linux with Mono.\n\n\nmono InEngineScheduler.exe\n\n\n\n\nOn Windows as a Service\n\n\nInstalling\n\n\nRun 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. \n\n\nps Install.ps1\n\n\n\n\nUninstalling\n\n\nSimply run the \nUninstall.ps1\n script with elevated permissions to unregister the service.\n\n\nps Uninstall.ps1\n\n\n\n\nOn Linux with Supervisor\n\n\nSupervisor is a process control system for Linux. It has extensive \ndocumentation\n, but the following should be enough to get started.\n\n\nInstalling Supervisor\n\n\nThis command installs Supervisor on Ubuntu:\n\n\nsudo apt-get install supervisor\n\n\n\n\nConfiguring Supervisor\n\n\nSupervisor configuration files are stored in the \n/etc/supervisor/conf.d\n 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 \n/etc/supervisor/conf.d/inengine-scheduler.conf\n. \n\n\n[program:inengine-scheudler]\nprocess_name=%(program_name)s_%(process_num)02d\ndirectory=/path/to/scheduler\ncommand=mono InEngineScheduler.exe\nautostart=true\nautorestart=true\nuser=InEngine\nnumprocs=1\nredirect_stderr=true\nstdout_logfile=./scheduler.log\n\n\n\n\nStarting Supervisor\n\n\nWhenever a configuration change happens to files in the Supervisor config files, Supervisor needs to be instructed to reload its configuration.\n\n\nsudo supervisorctl reread\nsudo supervisorctl update\n\n\n\n\nNow, simply start the InEngine Scheduler.\n\n\nsudo supervisorctl start inengine-scheduler:*",
6666
"title": "Scheduling"
6767
},
6868
{
@@ -72,7 +72,7 @@
7272
},
7373
{
7474
"location": "/scheduling/#scheduling-a-command",
75-
"text": "A job schedule is created by adding a class to your plugin assembly that implements the InEngine.Core.Jobs interface. \nusing System;\nusing Quartz;\n\nnamespace MyCommandPlugin\n{\n public class Jobs : IJobs\n {\n public void Schedule(IScheduler scheduler)\n {\n // Schedule some jobs\n }\n }\n} This class is automatically discovered by the InEngine.NET scheduler.\nIt will call the Jobs.Schedule method with an initialized Quartz.NET scheduler object. using System;\nusing Quartz;\nusing InEngine.Core.Queue.Commands;\nusing System.Collections.Generic;\nusing System.Linq;\n\nnamespace InEngine.Core.Queue\n{\n public class Jobs : IJobs\n {\n public void Schedule(IScheduler scheduler)\n {\n var myCommand = new MyCommand();\n\n // Generate a schedulable job with the command\n var job = myCommand.MakeTriggerBuilder().Build();\n\n // Generate a trigger for the job, and set its schedule to every 10 seconds.\n var trigger = myCommand.MakeTriggerBuilder().Build()\n .StartNow()\n .WithSimpleSchedule(x = x.WithIntervalInSeconds(10).RepeatForever())\n .Build();\n\n // Register the job and trigger with the scheduler\n scheduler.ScheduleJob(job, trigger);\n }\n }\n}",
75+
"text": "A job schedule is created by adding a class to your plugin assembly that implements the InEngine.Core.Jobs interface. \nusing System;\nusing Quartz;\n\nnamespace MyCommandPlugin\n{\n public class Jobs : IJobs\n {\n public void Schedule(IScheduler scheduler)\n {\n // Schedule some jobs\n }\n }\n} This class is automatically discovered by the InEngine.NET scheduler.\nIt will call the Jobs.Schedule method with an initialized Quartz.NET scheduler object. using System;\nusing Quartz;\n\nnamespace MyCommandPlugin\n{\n public class Jobs : IJobs\n {\n public void Schedule(IScheduler scheduler)\n {\n var myCommand = new MyCommand();\n\n // Generate a schedulable job with the command\n var job = myCommand.MakeTriggerBuilder().Build();\n\n // Generate a trigger for the job, and set its schedule to every 10 seconds.\n var trigger = myCommand.MakeTriggerBuilder().Build()\n .StartNow()\n .WithSimpleSchedule(x = x.WithIntervalInSeconds(10).RepeatForever())\n .Build();\n\n // Register the job and trigger with the scheduler\n scheduler.ScheduleJob(job, trigger);\n }\n }\n}",
7676
"title": "Scheduling a Command"
7777
},
7878
{

docs/scheduling/index.html

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,11 +128,8 @@ <h2 id="scheduling-a-command">Scheduling a Command</h2>
128128
It will call the Jobs.Schedule method with an initialized Quartz.NET scheduler object.</p>
129129
<pre><code class="csharp">using System;
130130
using Quartz;
131-
using InEngine.Core.Queue.Commands;
132-
using System.Collections.Generic;
133-
using System.Linq;
134131

135-
namespace InEngine.Core.Queue
132+
namespace MyCommandPlugin
136133
{
137134
public class Jobs : IJobs
138135
{

0 commit comments

Comments
 (0)