This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft-website.git
The following commit(s) were added to refs/heads/master by this push:
new e300636 WIP.
e300636 is described below
commit e300636aa1efa5deae19d9cf2b442800282f72ac
Author: Aaron Radzinski <[email protected]>
AuthorDate: Sun Nov 29 10:46:32 2020 -0800
WIP.
---
server-and-probe.html | 6 +++---
tools/script.html | 37 +++++++++++++++++++++++++++++++++----
2 files changed, 36 insertions(+), 7 deletions(-)
diff --git a/server-and-probe.html b/server-and-probe.html
index 00ae5f3..ef8c8ef 100644
--- a/server-and-probe.html
+++ b/server-and-probe.html
@@ -464,7 +464,7 @@ nlpcraft {
</p>
</section>
<section id="testing">
- <h2 class="section-title">Testing</h2>
+ <h2 class="section-title">CI Testing</h2>
<p>
It is a good practice to run units tests during routine builds
using Maven (or others CI toolchains). To
test data models you need to have a running server and then start
one or more data probes with
@@ -496,7 +496,7 @@ nlpcraft {
To get around this problem NLPCraft uses <a target="github"
href="https://github.com/bazaarvoice/maven-process-plugin";><code>process-exec-maven-plugin</code></a>
Maven plugin in its own build. This plugin allows to start the
external process and use configured URL
endpoint to check whether or not the external process has fully
started. This works perfect with NLPCraft server
- <a href="using-rest.html#misc">health check REST call</a>. The
plugin can be configured in the following way for your own project
+ <a href="/using-rest.html#tools">health check REST call</a>. The
plugin can be configured in the following way for your own project
(taken directly from NLPCraft <a target="github"
href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/pom.xml";><code>pom.xml</code></a>):
</p>
<pre class="brush: xml, highlight: [14, 16, 28]">
@@ -591,7 +591,7 @@ nlpcraft {
<li><a href="#config">Configuration</a></li>
<li><a href="#override">Custom Configuration</a></li>
<li><a href="#ansi">ANSI Colors</a></li>
- <li><a href="#testing">Testing</a></li>
+ <li><a href="#testing">CI Testing</a></li>
{% include quick-links.html %}
</ul>
</div>
diff --git a/tools/script.html b/tools/script.html
index 3339d8f..3864066 100644
--- a/tools/script.html
+++ b/tools/script.html
@@ -65,7 +65,7 @@ id: script
</li>
</ul>
<p>
- All the functionality remains the same regardless of whether a
command is executed from command line or
+ All the functionality and command syntax remain the same
regardless of whether a command is executed from a command line or
in REPL mode.
</p>
<p>
@@ -75,7 +75,11 @@ id: script
<img class="non-fluid-img" src="/images/cli1.png" alt="">
</p>
<p>
- Script starts in the REPL mode by default. Type <code>help</code>
to list of all supported commands:
+ Script starts in the REPL mode by default.
+ </p>
+ <h2 class="section-sub-title">Get Command List</h2>
+ <p>
+ Type <code>help</code> to list of all supported commands (or run
<code>bin/nlpcraft.sh help</code> if in command line mode):
</p>
<p>
<img class="non-fluid-img" src="/images/cli2.png" alt="">
@@ -95,6 +99,31 @@ id: script
<img class="non-fluid-img" alt="" src="/images/cli8.png">
</p>
</section>
+ <section id="os_commands">
+ <h2 class="section-title">OS Commands</h2>
+ <p>
+ You can run any external OS-specific commands from
<code>bin/nlpcraft.{sh|cmd}</code> script by prepending such
+ command with a <code>$</code> symbol. For example:
+ </p>
+ <pre class="brush: plain">
+ > $mvn clean package
+ </pre>
+ <p style="margin-left: 20px">
+ Runs Maven build in the current directory.
+ </p>
+ <pre class="brush: plain">
+ > $cmd /c dir
+ </pre>
+ <p style="margin-left: 20px">
+ Runs Windows <code>dir</code> command in the current directory
using a separate shell.
+ </p>
+ <p>
+ Note that <em>stdin</em>, <em>stderr</em> and <em>stdout</em> will
be redirected into running <code>bin/nlpcraft.{sh|cmd}</code> script.
+ Running OS commands makes the most sense in REPL mode where you
don't want to lose a session context while
+ executing external OS commands. Technically, however, external OS
commands can be executed from command line mode
+ as well.
+ </p>
+ </section>
<section id="usage">
<h2 class="section-title">Usage</h2>
<p>
@@ -204,8 +233,7 @@ id: script
<b>REPL Commands:</b>
<p>
REPL commands are set of utilities that you can use while
in REPL mode. Although all of these commands, as always,
- can be executed in the command like mode - they make most
sense in REPL mode (except for <code>help</code> command). When running
<code>help</code>
- command the list of REPL commands is available under
<b>REPL Commands</b> heading.
+ can be executed in the command like mode - they make most
sense in REPL mode (except for <code>help</code> command).
</p>
</li>
<li>
@@ -226,6 +254,7 @@ id: script
<li class="side-nav-title">On This Page</li>
<li><a href="#overview">Overview</a></li>
<li><a href="#quick_start">Quick Start</a></li>
+ <li><a href="#os_commands">OS Commands</a></li>
<li><a href="#usage">Usage</a></li>
{% include quick-links.html %}
</ul>
