Denis Magda created IGNITE-8589:
-----------------------------------
Summary: Prepare Node.JS Thin Client documentation
Key: IGNITE-8589
URL: https://issues.apache.org/jira/browse/IGNITE-8589
Project: Ignite
Issue Type: Task
Components: documentation
Reporter: Denis Magda
Assignee: Pavel Petroshenko
Fix For: 2.6
The hidden page is presently here:
https://apacheignite.readme.io/v2.4/docs/nodejs-thin-client
Once all the suggestions are resolved, we might split this page into several
pages. I can do this closer to 2.6 release.
[~pavel.petroshenko], [~alexey.kosenchuk], please address the following
suggestions for now:
Installation section:
* Ignite repository has to be used instead of the private one
* The section needs to explain the installation steps once the NPM module is
released. It's fine to put the current installation instructions under
"Installing from Sources" section.
Data Types:
* The term "field" is truly confusing. Does it really imply any possible data
(value, key, element of an array)? Why can't we use the term "value" instead?
* Provide a code snippet that shows how to configure the explicit mapping
* Default mapping has to be documented in place on readme.io (no references to
the private GIT repo)
Configuring Ignite Client
*Failover on a reconnect code snippet. How to pass a list of the endpoints.
General:
* You use CacheClient or just Cache notion to refer to an instance of the cache
class. Let's use one term. I prefer the Cache one or IgniteCache if it's named
this way.
* Add a reference to the examples once they are merged to Ignite repo (see the
latest section on the readme page)
* Add a reference to Node.JS APIs within supported APIs section.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
