[
https://issues.apache.org/jira/browse/IGNITE-8589?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16492184#comment-16492184
]
Pavel Petroshenko commented on IGNITE-8589:
-------------------------------------------
I updated the documentation at
https://apacheignite.readme.io/v2.4/docs/nodejs-thin-client
Ignite installation section:
# added installation from npmjs repository
# changed the links from the private git repo to the apache one (everywhere
across the document)
Data Types section:
# added a link to the "Types Mapping Configuration" section for more details
and code examples. It doesn't make sense to give it here as all the basic steps
need to be discussed first: instantiation, configuration, connection, etc.
Failover section:
# I updated the failover example to demonstrate how to pass multiple endpoints.
General section:
# CacheClient is referred to as Client
# Added a link to the examples (on master) that's going to work when the code
is merged
# Added a link to the API specification to the "Supported API" section.
Answering some other questions of yours:
1. Re the term "field", it's clearly defined in the documentation:
> The field here is any data stored in Ignite - the whole key or value of an
> Ignite entry, an element of an array or set, a field of a complex object, etc.
so calling it value won't be strictly accurate. "Field" is the best generic
enough term I've heard so far that describes what it actually means.
2. Re the duplication of the default mapping section. It is a part of the API
specification details and it is documented there. There is no need to move it
over to the main README as it a huge section of the API spec and moving just
the table won't make it any clear. So the README should just refer to the API
spec.
> 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
> Priority: Major
> 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)
