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 6f4fdd7 WIP.
6f4fdd7 is described below
commit 6f4fdd7c01f0150487485b17dc9fc99487290f01
Author: Aaron Radzinzski <[email protected]>
AuthorDate: Sat Sep 19 16:41:40 2020 -0700
WIP.
---
_scss/misc.scss | 7 +++++--
images/ansi_colors.png | Bin 0 -> 375920 bytes
server-and-probe.html | 42 ++++++++++++++++++++++++++++++++++--------
3 files changed, 39 insertions(+), 10 deletions(-)
diff --git a/_scss/misc.scss b/_scss/misc.scss
index 9591af8..66a2131 100644
--- a/_scss/misc.scss
+++ b/_scss/misc.scss
@@ -399,5 +399,8 @@ code {
width: 100% !important;
}
-
-
+.img-fluid-no-border {
+ max-width: 800px !important;
+ border-radius: 4px;
+ padding: 0 !important;
+}
diff --git a/images/ansi_colors.png b/images/ansi_colors.png
new file mode 100644
index 0000000..ae8d43c
Binary files /dev/null and b/images/ansi_colors.png differ
diff --git a/server-and-probe.html b/server-and-probe.html
index db71eba..dcaa3ea 100644
--- a/server-and-probe.html
+++ b/server-and-probe.html
@@ -388,10 +388,10 @@ nlpcraft {
</pre>
</section>
<section id="override">
- <h2 class="section-title">Override Configuration</h2>
+ <h2 class="section-title">Custom Configuration</h2>
<p>
- While you can change configuration file or files for your own
configuration (using <code>-config=...</code>
- parameter described above) it is frequently more convenient to use
the default configuration file and just
+ While you can change configuration file or files for your own
needs (and use <code>-config=...</code>
+ parameter described above to provide path to that file) it is
often more convenient to use the default configuration file and just
change one or two properties in it. You can accomplish this by
using standard
<a target=_
href="https://github.com/lightbend/config#optional-system-or-env-variable-overrides";>HOCON
overriding</a>
via environment variables:
@@ -442,6 +442,34 @@ nlpcraft {
</p>
</div>
</section>
+ <section id="ansi">
+ <h2 class="section-title">ANSI Colors</h2>
+ <p>
+ Both NLPCraft server and probe use ANSI coloring via
+ <a target=_
href="https://en.wikipedia.org/wiki/ANSI_escape_code";>ANSI escape sequences</a>
for their log
+ output by default. ANSI coloring provides easer console log
comprehension and modern estethics.
+ </p>
+ <figure>
+ <img class="img-fluid-no-border" src="/images/ansi_colors.png"
alt="">
+ <figcaption><b>Fig 1.</b> ANSI Colors</figcaption>
+ </figure>
+ <p>
+ However, there are
+ cases when either specific console does not support ANSI escape
sequences, or specific color schema
+ isn't suitable or log being redirected to a file or piped to
downstream system. In these cases you need to
+ disable ANSI coloring to avoid polluting log with unprocessed ANSI
escape codes.
+ </p>
+ <p>
+ You can disable ANSI coloring in either server, probe or both by
supplying the following system
+ property to JVM process:
<code>-D<b>NLPCRAFT_ANSI_COLOR_DISABLED</b>=true</code>
+ </p>
+
+ </section>
+ <section id="testing">
+ <h2 class="section-title">Testing</h2>
+ <p>
+ </p>
+ </section>
</div>
<div class="col-md-2 third-column">
<ul class="side-nav">
@@ -449,11 +477,9 @@ nlpcraft {
<li><a href="#server">REST Server</a></li>
<li><a href="#probe">Data Probe</a></li>
<li><a href="#config">Configuration</a></li>
- <li><a href="#override">Override Configuration</a></li>
+ <li><a href="#override">Custom Configuration</a></li>
+ <li><a href="#ansi">ANSI Colors</a></li>
+ <li><a href="#override">Testing</a></li>
{% include quick-links.html %}
</ul>
</div>
-
-
-
-
