Skip to content

Commit 7aef84b

Browse files
committed
Update docs
1 parent 2928007 commit 7aef84b

File tree

10 files changed

+948
-266
lines changed

10 files changed

+948
-266
lines changed

docs/404.html

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,18 @@
358358
</li>
359359

360360

361+
362+
363+
364+
365+
366+
<li class="md-nav__item">
367+
<a href="/server/" title="Server" class="md-nav__link">
368+
Server
369+
</a>
370+
</li>
371+
372+
361373
</ul>
362374
</nav>
363375
</li>

docs/commands/index.html

Lines changed: 12 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -401,13 +401,6 @@
401401

402402
</li>
403403

404-
<li class="md-nav__item">
405-
<a href="#logging" title="Logging" class="md-nav__link">
406-
Logging
407-
</a>
408-
409-
</li>
410-
411404

412405

413406
</ul>
@@ -453,6 +446,18 @@
453446
</li>
454447

455448

449+
450+
451+
452+
453+
454+
<li class="md-nav__item">
455+
<a href="../server/" title="Server" class="md-nav__link">
456+
Server
457+
</a>
458+
</li>
459+
460+
456461
</ul>
457462
</nav>
458463
</li>
@@ -533,13 +538,6 @@
533538

534539
</li>
535540

536-
<li class="md-nav__item">
537-
<a href="#logging" title="Logging" class="md-nav__link">
538-
Logging
539-
</a>
540-
541-
</li>
542-
543541

544542

545543
</ul>
@@ -757,24 +755,6 @@ <h2 id="view-a-commands-help-text">View a Command's Help Text<a class="headerlin
757755
--secondary (Default: False) Publish the command to the secondary
758756
queue.
759757
</pre></div>
760-
761-
762-
<h2 id="logging">Logging<a class="headerlink" href="#logging" title="Permanent link">&para;</a></h2>
763-
<p>Any exceptions thrown by a command will be logged provided NLog is configured to record errors.
764-
The <a href="https://github.com/NLog/NLog/wiki/Tutorial#configuration">NLog configuration</a> file needs to be setup with something like this: </p>
765-
<div class="codehilite"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot; ?&gt;</span>
766-
<span class="nt">&lt;nlog</span> <span class="na">xmlns=</span><span class="s">&quot;http://www.nlog-project.org/schemas/NLog.xsd&quot;</span>
767-
<span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="nt">&gt;</span>
768-
769-
<span class="nt">&lt;targets&gt;</span>
770-
<span class="nt">&lt;target</span> <span class="na">name=</span><span class="s">&quot;logfile&quot;</span> <span class="na">xsi:type=</span><span class="s">&quot;File&quot;</span> <span class="na">fileName=</span><span class="s">&quot;inengine.log&quot;</span> <span class="nt">/&gt;</span>
771-
<span class="nt">&lt;/targets&gt;</span>
772-
773-
<span class="nt">&lt;rules&gt;</span>
774-
<span class="nt">&lt;logger</span> <span class="na">name=</span><span class="s">&quot;*&quot;</span> <span class="na">minlevel=</span><span class="s">&quot;Error&quot;</span> <span class="na">writeTo=</span><span class="s">&quot;logfile&quot;</span> <span class="nt">/&gt;</span>
775-
<span class="nt">&lt;/rules&gt;</span>
776-
<span class="nt">&lt;/nlog&gt;</span>
777-
</pre></div>
778758

779759

780760

docs/configuration/index.html

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -382,6 +382,13 @@
382382
<label class="md-nav__title" for="toc">Table of contents</label>
383383
<ul class="md-nav__list" data-md-scrollfix>
384384

385+
<li class="md-nav__item">
386+
<a href="#inengine-settings" title="InEngine Settings" class="md-nav__link">
387+
InEngine Settings
388+
</a>
389+
390+
</li>
391+
385392
<li class="md-nav__item">
386393
<a href="#top-level-settings" title="Top-level Settings" class="md-nav__link">
387394
Top-level Settings
@@ -403,6 +410,13 @@
403410

404411
</li>
405412

413+
<li class="md-nav__item">
414+
<a href="#logging-settings" title="Logging Settings" class="md-nav__link">
415+
Logging Settings
416+
</a>
417+
418+
</li>
419+
406420

407421

408422
</ul>
@@ -412,6 +426,18 @@
412426
</li>
413427

414428

429+
430+
431+
432+
433+
434+
<li class="md-nav__item">
435+
<a href="../server/" title="Server" class="md-nav__link">
436+
Server
437+
</a>
438+
</li>
439+
440+
415441
</ul>
416442
</nav>
417443
</li>
@@ -437,6 +463,13 @@
437463
<label class="md-nav__title" for="toc">Table of contents</label>
438464
<ul class="md-nav__list" data-md-scrollfix>
439465

466+
<li class="md-nav__item">
467+
<a href="#inengine-settings" title="InEngine Settings" class="md-nav__link">
468+
InEngine Settings
469+
</a>
470+
471+
</li>
472+
440473
<li class="md-nav__item">
441474
<a href="#top-level-settings" title="Top-level Settings" class="md-nav__link">
442475
Top-level Settings
@@ -458,6 +491,13 @@
458491

459492
</li>
460493

494+
<li class="md-nav__item">
495+
<a href="#logging-settings" title="Logging Settings" class="md-nav__link">
496+
Logging Settings
497+
</a>
498+
499+
</li>
500+
461501

462502

463503
</ul>
@@ -474,6 +514,7 @@
474514

475515

476516
<h1 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h1>
517+
<h2 id="inengine-settings">InEngine Settings<a class="headerlink" href="#inengine-settings" title="Permanent link">&para;</a></h2>
477518
<p>Configuration is accomplished by modifying the appsettings.json file that comes with the InEngine.NET binary distribution.
478519
The <strong>-c, --configuration</strong> argument can also be used to specify an alternate configuration file.</p>
479520
<div class="codehilite"><pre><span></span><span class="p">{</span>
@@ -611,6 +652,27 @@ <h2 id="queue-settings">Queue Settings<a class="headerlink" href="#queue-setting
611652
</tr>
612653
</tbody>
613654
</table>
655+
<h2 id="logging-settings">Logging Settings<a class="headerlink" href="#logging-settings" title="Permanent link">&para;</a></h2>
656+
<p>Any exceptions thrown by a command will be logged, provided NLog is configured to log exceptions.
657+
The <a href="https://github.com/NLog/NLog/wiki/Tutorial#configuration">NLog configuration</a> file needs to be setup with something like this: </p>
658+
<div class="codehilite"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot; ?&gt;</span>
659+
<span class="nt">&lt;nlog</span> <span class="na">xmlns=</span><span class="s">&quot;http://www.nlog-project.org/schemas/NLog.xsd&quot;</span>
660+
<span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="nt">&gt;</span>
661+
662+
<span class="nt">&lt;targets&gt;</span>
663+
<span class="nt">&lt;target</span> <span class="na">name=</span><span class="s">&quot;logfile&quot;</span> <span class="na">xsi:type=</span><span class="s">&quot;File&quot;</span> <span class="na">fileName=</span><span class="s">&quot;inengine.log&quot;</span> <span class="nt">/&gt;</span>
664+
<span class="nt">&lt;/targets&gt;</span>
665+
666+
<span class="nt">&lt;rules&gt;</span>
667+
<span class="nt">&lt;logger</span> <span class="na">name=</span><span class="s">&quot;*&quot;</span> <span class="na">minlevel=</span><span class="s">&quot;Error&quot;</span> <span class="na">writeTo=</span><span class="s">&quot;logfile&quot;</span> <span class="nt">/&gt;</span>
668+
<span class="nt">&lt;/rules&gt;</span>
669+
<span class="nt">&lt;/nlog&gt;</span>
670+
</pre></div>
671+
672+
673+
<p>InEngine.Core does not depend explicitly on NLog, but rather <a href="http://net-commons.github.io/common-logging/">Common.Logging</a>.
674+
This means that any logging framework that Common.Logging supports can be used.
675+
Configuring Common.Logging to use a different logging framework is out of the scope of this documentation.</p>
614676

615677

616678

@@ -644,6 +706,20 @@ <h2 id="queue-settings">Queue Settings<a class="headerlink" href="#queue-setting
644706
</a>
645707

646708

709+
<a href="../server/" title="Server" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
710+
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
711+
<span class="md-flex__ellipsis">
712+
<span class="md-footer-nav__direction">
713+
Next
714+
</span>
715+
Server
716+
</span>
717+
</div>
718+
<div class="md-flex__cell md-flex__cell--shrink">
719+
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
720+
</div>
721+
</a>
722+
647723
</nav>
648724
</div>
649725

docs/index.html

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,18 @@
408408
</li>
409409

410410

411+
412+
413+
414+
415+
416+
<li class="md-nav__item">
417+
<a href="server/" title="Server" class="md-nav__link">
418+
Server
419+
</a>
420+
</li>
421+
422+
411423
</ul>
412424
</nav>
413425
</li>

docs/license/index.html

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -369,6 +369,18 @@
369369
</li>
370370

371371

372+
373+
374+
375+
376+
377+
<li class="md-nav__item">
378+
<a href="../server/" title="Server" class="md-nav__link">
379+
Server
380+
</a>
381+
</li>
382+
383+
372384
</ul>
373385
</nav>
374386
</li>

docs/queuing/index.html

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -562,6 +562,18 @@
562562
</li>
563563

564564

565+
566+
567+
568+
569+
570+
<li class="md-nav__item">
571+
<a href="../server/" title="Server" class="md-nav__link">
572+
Server
573+
</a>
574+
</li>
575+
576+
565577
</ul>
566578
</nav>
567579
</li>

0 commit comments

Comments
 (0)