This is an automated email from the ASF dual-hosted git repository. dbarnes pushed a commit to branch develop in repository https://gitbox.apache.org/repos/asf/geode-native.git
The following commit(s) were added to refs/heads/develop by this push: new 16e0e47 GEODE-4728: Native Client doc improvements - Incorporate reviewer suggestions 16e0e47 is described below commit 16e0e4735d8eaf2f1d9ddbf59b81de2fa04b7786 Author: Dave Barnes <dbar...@pivotal.io> AuthorDate: Wed Sep 26 17:27:40 2018 -0700 GEODE-4728: Native Client doc improvements - Incorporate reviewer suggestions --- .../master_middleman/source/subnavs/geode-nc-nav.erb | 10 +++++++++- .../configuring/config-client-cache.html.md.erb | 5 +---- .../configuring/system-level-configuration.html.md.erb | 12 ++++++------ .../getting-started/getting-started-nc-client.html.md.erb | 8 +++++--- docs/geode-native-docs/regions/regions.html.md.erb | 2 +- 5 files changed, 22 insertions(+), 15 deletions(-) diff --git a/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb b/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb index a1eccfc..fdd1133 100644 --- a/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb +++ b/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb @@ -24,8 +24,16 @@ limitations under the License. <li class="has_submenu"> <a href="/docs/geode-native/<%=vars.product_version_nodot%>/getting-started/getting-started-nc-client.html">Getting Started with the Native Library</a> <ul> - <li> + <li class="has_submenu"> <a href="/docs/geode-native/<%=vars.product_version_nodot%>/getting-started/getting-started-nc-client.html#app_dev_walkthroughs">Application Development Walkthroughs</a> + <ul> + <li> + <a href="/docs/geode-native/<%=vars.product_version_nodot%>/getting-started/app-dev-walkthrough-cpp.html">C++ App Development Walkthrough</a> + </li> + <li> + <a href="/docs/geode-native/<%=vars.product_version_nodot%>/getting-started/app-dev-walkthrough-dotnet.html">.NET App Development Walkthrough</a> + </li> + </ul> </li> <li> <a href="/docs/geode-native/<%=vars.product_version_nodot%>/getting-started/getting-started-nc-client.html#programming_examples">Programming Examples</a> diff --git a/docs/geode-native-docs/configuring/config-client-cache.html.md.erb b/docs/geode-native-docs/configuring/config-client-cache.html.md.erb index 541c400..4c7ab65 100644 --- a/docs/geode-native-docs/configuring/config-client-cache.html.md.erb +++ b/docs/geode-native-docs/configuring/config-client-cache.html.md.erb @@ -40,7 +40,4 @@ The `Cache` inherits `RegionService` and adds management of these client caching - Region creation - Subscription keepalive management for durable clients - Access to the underlying distributed system -- `RegionService` creation for secure access by multiple users -See [Creating Multiple Secure User Connections with RegionService](../security/createsecureconnregionservice.html) - - +- `RegionService` creation for secure access by multiple users (see [Creating Multiple Secure User Connections with RegionService](../security/createsecureconnregionservice.html). diff --git a/docs/geode-native-docs/configuring/system-level-configuration.html.md.erb b/docs/geode-native-docs/configuring/system-level-configuration.html.md.erb index 27b2fb6..623e657 100644 --- a/docs/geode-native-docs/configuring/system-level-configuration.html.md.erb +++ b/docs/geode-native-docs/configuring/system-level-configuration.html.md.erb @@ -29,7 +29,7 @@ In case an attribute is defined in more than one place, the first source in this - Programmatic configuration - Properties set at the command line - <code>_current-working-directory_/geode.properties</code> file -- <code>_native-client-dir_/defaultSystem/geode.properties</code> file +- <code>_native-client-installation-directory_/defaultSystem/geode.properties</code> file - defaults The `geode.properties` files and programmatic configuration are optional. If they are not present, @@ -39,9 +39,9 @@ object, see [Defining Properties Programmatically](#native-client-config_definin ## <a id="native-client-config_search_path_for_props"></a>Search Path for Multiple Properties Files The client and cache server processes first look for their properties file in the -<code>_native-client-dir_/defaultSystem</code> directory, then in the working directory. +<code>_native-client-installation-directory_/defaultSystem</code> directory, then in the working directory. -Any properties set in the working directory override settings in the `defaultSystem/geode.properties` file. +Any properties set in the working directory override settings in the <code>_native-client-installation-directory_/defaultSystem/geode.properties</code> file. The `geode.properties` file provides information to the client regarding the expected server configuration. Properties set in this file (in the client environment) do not have any effect on the @@ -69,14 +69,14 @@ The `geode.properties` file provides local settings required to connect a client ## <a id="native-client-config__section_88780874FD6C4BBD9B1B993758A985BB"></a>Configuration File Locations -A client looks for a `geode.properties` file first in the working directory where the process runs, then in <code>_native-client-dir_/defaultSystem</code>. +A client looks for a `geode.properties` file first in the working directory where the process runs, then in <code>_native-client-installation-directory_/defaultSystem</code>. Use the `defaultSystem` directory to group configuration files or to share them among processes for more convenient administration. If `geode.properties` is not found, the process starts up with the default settings. For the `cache.xml` cache configuration file, a client looks for the path specified by the `cache-xml-file` attribute in `geode.properties` (see [System Properties](sysprops.html#attributes-gfcpp)). If the `cache.xml` is not found, the process starts with an unconfigured cache. ## <a id="native-client-config_using_default_sample_file"></a>Using the Default Sample File -A sample `geode.properties` file is included with the <%=vars.product_name_long%> native client installation in the <code>_native-client-dir_/defaultSystem</code> directory. +A sample `geode.properties` file is included with the <%=vars.product_name_long%> native client installation in the <code>_native-client-installation-directory_/defaultSystem</code> directory. To use this file: @@ -121,7 +121,7 @@ To use this file: The typical configuration procedure for a client includes the high-level steps listed below. -1. Place the `geode.properties` file for the application in the working directory or in <code>_native-client-dir_/defaultSystem</code>. +1. Place the `geode.properties` file for the application in the working directory or in <code>_native-client-installation-directory_/defaultSystem</code>. 1. Place the `cache.xml` file for the application in the desired location and specify its path using the `cache-xml-file` property in the `geode.properties` file. 1. Add other attributes to the `geode.properties` file as needed for the local system architecture. diff --git a/docs/geode-native-docs/getting-started/getting-started-nc-client.html.md.erb b/docs/geode-native-docs/getting-started/getting-started-nc-client.html.md.erb index 187f340..639ef57 100644 --- a/docs/geode-native-docs/getting-started/getting-started-nc-client.html.md.erb +++ b/docs/geode-native-docs/getting-started/getting-started-nc-client.html.md.erb @@ -13,7 +13,7 @@ To use the <%=vars.product_name%> Native Library for developing <%=vars.product_ Whether you are developing a C++ or .NET application, you will need some essential tools, such as a compiler and a linker. Your compiler must have access to the Native Client header files, and the linker must have access to the Native Client libraries. -The header files and libraries are located in the Native Client installation directory (referred to as *native-client-dir* elsewhere in this guide). +The header files and libraries are located in the Native Client installation directory. ## <a id="establish_cluster_access"></a>Establish Access to a <%=vars.product_name%> Cluster @@ -23,8 +23,8 @@ or IP address) and port number of one or more locators, and the name of a region on the cluster. The client API establishes a pool of these network connections for your client application to use. -You can choose whether to use a large, remote, production-quality cluster, a small, local, -development cluster, or something in-between, such as a testing or experimental lab installation. +You can choose whether to use a large, remote, production-quality cluster; a small, local, +development cluster; or something in-between, such as a testing or experimental lab installation. In the _<%=vars.product_name%> User's Guide_, see [Configuring and Running a Cluster](/serverman/configuring/chapter_overview.html) @@ -105,6 +105,8 @@ for more details. ### <a id="app_dev_walkthroughs"></a>Application Development Walkthroughs +The application development walkthroughs describe how to set up a native client development environment using CMake. + - [C++ App Development Walkthrough](app-dev-walkthrough-cpp.html) - [.NET App Development Walkthrough](app-dev-walkthrough-dotnet.html) diff --git a/docs/geode-native-docs/regions/regions.html.md.erb b/docs/geode-native-docs/regions/regions.html.md.erb index 92a8359..fc719c0 100644 --- a/docs/geode-native-docs/regions/regions.html.md.erb +++ b/docs/geode-native-docs/regions/regions.html.md.erb @@ -38,7 +38,7 @@ Region creation is subject to attribute consistency checks. To create a region: 1. Instantiate a `CacheFactory` and use it to create a cache. -1. The cache includes an instance of `PoolManager` -- use it to create a connection pool. +1. The cache includes an instance of `PoolManager`—use it to create a connection pool. 1. Use cache to instantiate a `RegionFactory` and use it to create a region, specifying any desired attributes and an association with the connection pool.