add configuration overview chapter documentation #342

furkansenharputlu · 2018-09-03T08:11:46Z

This PR adds documentation for Configuration Overview chapter in the issue #340.

furkansenharputlu · 2018-09-03T11:14:05Z

verify

Serdaro

Reviewed.

Serdaro · 2018-09-03T11:30:51Z

README.md

+
+### 1.1. Programmatic Configuration
+
+For programmatic configuration of the Hazelcast Java Client, just instantiate a ClientConfig object and configure the


...of the Hazelcast Node.js Client, just instantiate a ClientConfig object and...

mustafaiman · 2018-09-06T19:31:20Z

README.md

+return HazelcastClient.newHazelcastClient(cfg);
+```
+
+Refer to [Hazelcast Node.js Client API Docs](http://hazelcast.github.io/hazelcast-nodejs-client/api/current/docs) for details.


"Refer to Config class documentation at .... for details" may be better.

mustafaiman · 2018-09-06T19:33:47Z

README.md

+
+### 1.1. Programmatic Configuration
+
+For programmatic configuration of the Hazelcast Java Client, just instantiate a `ClientConfig` object and configure the


Hazelcast Java Client typo

mustafaiman · 2018-09-06T19:37:06Z

README.md

@@ -97,11 +103,154 @@ Please see Hazelcast Node.js [code samples](https://github.com/hazelcast/hazelca

 You can also refer to Hazelcast Node.js [API Documentation](http://hazelcast.github.io/hazelcast-nodejs-client/api/current/docs/).

-# Configuration
+# Configuration Overview


Empty titles are not good to have. I think we can get rid of Configuration Options title and tell what it says there just under this title

I added a description here so the title is not empty.

Serdaro

Reviewed.

Serdaro · 2018-09-07T09:22:58Z

README.md

-# Configuration
+# Configuration Overview
+
+## 1. Configuration Options


Let's remove the Configuration Options subtitle.

But, what should be the indexes of subsections 1.1. Programmatic Configuration and 1.2. Declarative Configuration (JSON)? Configuration Options makes them meaningful. Like 1.x.

Serdaro · 2018-09-07T09:24:13Z

README.md

+
+### 1.1. Programmatic Configuration
+
+For programmatic configuration of the Hazelcast Java Client, just instantiate a `ClientConfig` object and configure the


...of the Hazelcast Node.js client, just instantiate...

Serdaro · 2018-09-07T11:52:13Z

README.md

+
+### 1.2. Declarative Configuration (JSON)
+
+For declarative configuration, the Hazelcast client looks at the following places for the client configuration file.


For declarative configuration, the client checks the following places for the JSON configuration file, in the given order:

Serdaro · 2018-09-07T11:53:35Z

README.md

+the client looks for the configuration file in the specified location.
+2. Current working directory: If there is no environment variable set, the client tries to load `hazelcast-client.json`
+from the current working directory.
+3. Default configuration: If all of the above methods fail, the client starts with the default configuration.


Can we give the location/whereabout of the default JSON configuration file? Where can I find this default file?

There isn't any default file. Default configuration is programmatic. If user wants to override, he needs to create hazelcast-client.json.

Can we put this above explanation of yours about the default configuration? -> Please add an explanatory content/sentence to the number 3 above. It may include the fact that default configuration is programmatic for which I assume the ClientConfig object has some default properties (which can be given here too), and the fact that if the default configuration does not meet the user's requirements, he/she should create a hazelcast-client.json file which should reside in the current working directory.

Serdaro · 2018-09-07T11:58:24Z

README.md

+        "connectionAttemptLimit": 3
+    }
+}
+```


Please provide a cross-reference like relational text here. Something like:

"In the following chapters you will learn the description of all elements included in a JSON configuration file used to configure Hazelcast Node.js client."

Serdaro · 2018-09-07T12:56:29Z

README.md

+
+## 2. Importing Multiple Configurations
+
+You can compose the declarative configuration of your Hazelcast client from multiple declarative


..of your Node.js client...

Serdaro · 2018-09-07T12:56:56Z

README.md

+}
+```
+
+To get your example Hazelcast declarative configuration out of the above two, use the `import` element as


...example client configuration out of the above...

Serdaro

More reviews.

Serdaro · 2018-09-10T07:19:36Z

README.md

+the client looks for the configuration file in the specified location.
+2. Current working directory: If there is no environment variable set, the client tries to load `hazelcast-client.json`
+from the current working directory.
+3. Default configuration: If all of the above methods fail, the client starts with the default configuration.


Can we put this above explanation of yours about the default configuration? -> Please add an explanatory content/sentence to the number 3 above. It may include the fact that default configuration is programmatic for which I assume the ClientConfig object has some default properties (which can be given here too), and the fact that if the default configuration does not meet the user's requirements, he/she should create a hazelcast-client.json file which should reside in the current working directory.

mustafaiman · 2018-09-11T21:22:34Z

README.md

+
+### 1.2. Declarative Configuration (JSON)
+
+For declarative configuration, the client looks at the following places for the client configuration file.


If the client is not supplied with a programmatic configuration at the time of initialization, it will look for a configuration file named hazelcast-client.json. If this file exists, then the configuration is loaded from it. Otherwise, the client will start with the default configuration. The following are the places that the client looks for a hazelcast-client.json in order:

mustafaiman · 2018-09-11T21:27:13Z

README.md

+
+In the following chapters you will learn the description of all elements included in a JSON configuration file used to configure Hazelcast Node.js client.
+
+## 2. Importing Multiple Configurations


Are we sure that this section is an Guide to using the Node.js Client with Hazelcast section? It feels a bit unneccessary for someone trying to get started with Node.js client. If we are going to keep CONFIG.md in the end, this should be only there I think. @Serdaro

@mustafaiman , What I think is: since this "composing a configuration" is a Hazelcast feature, it would look nice to mention it with examples (as it is now) here, so that the user can learn how the importing mechanism works when a Node.js client is being configured. And since I think we agreed on moving the CONFIG.md content to the main README, there is no harm keeping this here.

Serdaro

👍

furkansenharputlu added the Type: Documentation label Sep 3, 2018

furkansenharputlu added this to the 3.10 milestone Sep 3, 2018

furkansenharputlu self-assigned this Sep 3, 2018

furkansenharputlu requested review from Serdaro and mustafaiman September 3, 2018 08:11

furkansenharputlu added this to In progress in 0.10 Sep 3, 2018

Serdaro requested changes Sep 3, 2018

View reviewed changes

furkansenharputlu force-pushed the confOverviewDoc branch from 1fc177a to 5209a73 Compare September 3, 2018 11:43

Serdaro approved these changes Sep 3, 2018

View reviewed changes

mustafaiman reviewed Sep 6, 2018

View reviewed changes

furkansenharputlu mentioned this pull request Sep 6, 2018

Adds getting started in Readme.MD #349

Merged

Serdaro requested changes Sep 7, 2018

View reviewed changes

furkansenharputlu force-pushed the confOverviewDoc branch 3 times, most recently from d1bf11d to de5d092 Compare September 7, 2018 14:15

Serdaro requested changes Sep 10, 2018

View reviewed changes

furkansenharputlu force-pushed the confOverviewDoc branch from de5d092 to ee82951 Compare September 10, 2018 14:35

mustafaiman reviewed Sep 11, 2018

View reviewed changes

add configuration overview chapter documentation

931de06

furkansenharputlu force-pushed the confOverviewDoc branch from ee82951 to 931de06 Compare September 12, 2018 15:30

mustafaiman approved these changes Sep 19, 2018

View reviewed changes

Serdaro approved these changes Sep 20, 2018

View reviewed changes

furkansenharputlu merged commit e81aa55 into hazelcast:master Sep 20, 2018

furkansenharputlu moved this from In progress to Done in 0.10 Oct 1, 2018

harunalpak pushed a commit to harunalpak/hazelcast-nodejs-client that referenced this pull request Dec 8, 2022

add configuration overview chapter documentation (hazelcast#342)

9625722

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add configuration overview chapter documentation #342

add configuration overview chapter documentation #342

furkansenharputlu commented Sep 3, 2018

furkansenharputlu commented Sep 3, 2018

Serdaro left a comment

Serdaro Sep 3, 2018

mustafaiman Sep 6, 2018

mustafaiman Sep 6, 2018

mustafaiman Sep 6, 2018

furkansenharputlu Sep 7, 2018

Serdaro left a comment

Serdaro Sep 7, 2018

furkansenharputlu Sep 7, 2018

Serdaro Sep 7, 2018

Serdaro Sep 7, 2018

Serdaro Sep 7, 2018

furkansenharputlu Sep 7, 2018

Serdaro Sep 10, 2018

Serdaro Sep 7, 2018

Serdaro Sep 7, 2018

Serdaro Sep 7, 2018

Serdaro left a comment

Serdaro Sep 10, 2018

mustafaiman Sep 11, 2018

mustafaiman Sep 11, 2018

Serdaro Sep 17, 2018

mustafaiman Sep 17, 2018

Serdaro left a comment


		### 1.1. Programmatic Configuration

		For programmatic configuration of the Hazelcast Java Client, just instantiate a ClientConfig object and configure the


		### 1.2. Declarative Configuration (JSON)

		For declarative configuration, the Hazelcast client looks at the following places for the client configuration file.


		## 2. Importing Multiple Configurations

		You can compose the declarative configuration of your Hazelcast client from multiple declarative


		In the following chapters you will learn the description of all elements included in a JSON configuration file used to configure Hazelcast Node.js client.

		## 2. Importing Multiple Configurations

add configuration overview chapter documentation #342

add configuration overview chapter documentation #342

Conversation

furkansenharputlu commented Sep 3, 2018

furkansenharputlu commented Sep 3, 2018

Serdaro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Serdaro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Serdaro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Serdaro left a comment

Choose a reason for hiding this comment