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
commit 6dfb1e6d153d562110de73db0bc02842557f1b40 Author: Aaron Radzinski <[email protected]> AuthorDate: Sun Aug 16 13:10:10 2020 -0700 Fixed external config docs. --- download.html | 76 ------------------------------------------------------- installation.html | 13 ++++++++++ 2 files changed, 13 insertions(+), 76 deletions(-) diff --git a/download.html b/download.html index 1b48dbb..71b5ac1 100644 --- a/download.html +++ b/download.html @@ -311,81 +311,6 @@ layout: interior </p> </div> </section> - <section id="3rd-party-config"> - <h2 class="section-title">3rd Part Configuration</h2> - <p> - Due to licensing limitations the official Apache Release comes with only default configurations - for spelling and geographical subsystems (spelling and geo enrichers). As a user of NLPCraft you are - free to extend the default configuration and provide your own configuration (see <code>nlpcraft/src/main/resources</code> folder). - </p> - <p> - Alternatively, you can also download - the pre-packaged configuration for both spelling and/or geo enrichers. - However, these packages are based on - the content licensed under <a target="_" href="https://creativecommons.org/licenses/by/4.0/";>CC BY 4.0 license</a> - and you need to ensure that you can comply with that license before downloading these packages: - </p> - <table class="gradient-table max-width"> - <thead> - <tr> - <th>File Name</th> - <th>Release Date</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td> - <nobr> - <i class="fa fa-fw fa-download"></i> <a href="https://github.com/apache/incubator-nlpcraft/raw/master/external/cc_by40_geo_config.zip";>cc_by40_geo_config.zip</a> - </nobr> - </td> - <td><nobr>July 8, 2020</nobr></td> - <td> - Comprehensive GEO data configuration based on various open source data sources. Portion of the - configuration is based on the content licensed under <a target="_" href="https://creativecommons.org/licenses/by/4.0/";>CC BY 4.0 license</a>. - </td> - </tr> - <tr> - <td> - <nobr> - <i class="fa fa-fw fa-download"></i> <a href="https://github.com/apache/incubator-nlpcraft/raw/master/external/cc_by40_spell_config.zip";>cc_by40_spell_config.zip</a> - </nobr> - </td> - <td> - <nobr>July 8, 2020</nobr> - </td> - <td> - Comprehensive spelling database that is based on various open source data sources. Based - on the content licensed under <a target="_" href="https://creativecommons.org/licenses/by/4.0/";>CC BY 4.0 license</a>. - </td> - </tr> - </tbody> - </table> - <div class="bq success"> - <p> - Unless noted otherwise these configuration files work with NLPCraft <b>ver. 0.6.2 or later</b>. - </p> - </div> - <p> - To install one or both pre-package configurations: - </p> - <ul> - <li>Download desired files and unzip them into <i>target folder</i>.</li> - <li> - Add system property <code>-DNLPCRAFT_RESOURCE_EXT=/full/path</code> to NLPCraft server runtime, where: - <ul> - <li> - <code>/full/path</code> - fully qualified path to the <i>target folder</i> where files were unzipped. - </li> - </ul> - </li> - <li> - Restart NLPCraft server. - </li> - </ul> - - </section> <section id="java-client"> <h2 class="section-title">Java Client <i class="fab fa-java"></i></h2> <p> @@ -449,7 +374,6 @@ layout: interior <li><a href="#verification">Verification</a></li> <li><a href="#maven">Maven/Grape/SBT</a></li> <li><a href="#github">GitHub</a></li> - <li><a href="#3rd-party-config">3rd Party Config <i style="color: #666;" class="fas fa-fw fa-download"></i></a></li> <li><a href="#java-client">Java Client</a></li> {% include quick-links.html %} </ul> diff --git a/installation.html b/installation.html index 3225fb4..6f5ae97 100644 --- a/installation.html +++ b/installation.html @@ -35,6 +35,19 @@ id: installation </section> <section id="config"> <h2 class="section-title">External Configuration</h2> + <p> + Due to <a target="asf" href="http://apache.org/legal/release-policy.html";>Apache release policy</a> the official Apache release cannot include content that is based on + <a target=_ href="https://creativecommons.org/licenses/by/4.0/";>Commons Attribution 4.0 International</a> (CC BY 4.0) license + or any binary artifacts regardless of their respective licences. Due to these restrictions the NLPCraft release + does not include certain configuration files that are necessary for its operation. These files will be auto-downloaded upon first star of NLPCraft. + On subsequent starts the NLPCraft will check for the updates and will re-download these files only if they were changed. + </p> + <p> + By default, this external configuration is hosted on GitHub (master branch of NLPCraft project) from where it will + be automatically downloaded on the first start: <a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/external";>https://github.com/apache/incubator-nlpcraft/tree/master/external</a>. + You can change this location, e.g. move external configuration behind your firewall, as well as change other parameters related to auto-download of the external configuration + in <code>nlpcraft.conf</code> file (see <code>nlpcraft.extConfig</code> property). + </p> </section> <section id="ignite"> <h2 class="section-title">Apache Ignite 2.7 <span class="amp">&</span> Java 9+</h2>
