You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by db...@apache.org on 2018/04/24 20:20:35 UTC
[geode-native] branch develop updated: Docs update
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 04b0d7c Docs update
04b0d7c is described below
commit 04b0d7c647b3cf048d0e5ce121a87a7a1f9c7e20
Author: Dave Barnes <db...@pivotal.io>
AuthorDate: Tue Apr 24 13:20:28 2018 -0700
Docs update
---
docs/geode-native-book/config.yml | 1 +
.../client-cache/cache-init-file.html.md.erb | 2 +-
.../client-cache/cache-ownership.html.md.erb | 28 -----
.../client-cache/caches.html.md.erb | 116 +++++++++++++++++++--
.../client-cache/caching-apis.html.md.erb | 45 --------
.../client-cache/chapter-overview.html.md.erb | 8 +-
.../client-cache/closing-cache.html.md.erb | 28 -----
.../concurrency-checks-enabled.html.md.erb | 2 +-
.../controlling-cache-size.html.md.erb | 2 +-
.../client-cache/create-access-cache.html.md.erb | 69 ------------
.../client-cache/overview-client-cache.html.md.erb | 41 --------
.../configuring/client-config-notes.txt | 28 +++++
.../configuring/configuration.html.md.erb | 3 +-
.../configuring/sysprops.html.md.erb | 4 +-
.../consistency-checking-in-regions.html.md.erb | 0
.../declarative-region-creation.html.md.erb | 2 +-
.../getting-the-region-size.html.md.erb | 0
.../invalidating-region.html.md.erb | 0
.../programmatic-region-creation.html.md.erb | 0
.../region-access.html.md.erb | 0
.../region-attributes-desc.html.md.erb | 0
.../region-attributes.html.md.erb | 18 ++--
.../region-shortcuts.html.md.erb | 0
.../{client-cache => regions}/regions.html.md.erb | 0
.../specify-region-attributes.html.md.erb | 0
25 files changed, 156 insertions(+), 241 deletions(-)
diff --git a/docs/geode-native-book/config.yml b/docs/geode-native-book/config.yml
index fdb3081..13d5ec0 100644
--- a/docs/geode-native-book/config.yml
+++ b/docs/geode-native-book/config.yml
@@ -29,6 +29,7 @@ template_variables:
product_name: Geode
product_version: 1.5
product_version_nodot: 15
+ client_name: Geode Native
min_java_update: 121
support_url: http://geode.apache.org/community
product_url: http://geode.apache.org
diff --git a/docs/geode-native-docs/client-cache/cache-init-file.html.md.erb b/docs/geode-native-docs/client-cache/cache-init-file.html.md.erb
index ab0b62d..e6f1385 100644
--- a/docs/geode-native-docs/client-cache/cache-init-file.html.md.erb
+++ b/docs/geode-native-docs/client-cache/cache-init-file.html.md.erb
@@ -41,7 +41,7 @@ The contents of a declarative XML file correspond to APIs declared in the `Cache
An example `cache.xml` file shows cache and region initialization for a client, presenting a subset of the possible data configurations.
-Specific information about cache and region attributes is in [Region Attributes](../client-cache/region-attributes.html).
+Specific information about cache and region attributes is in [Region Attributes](../regions/region-attributes.html).
For information on using a cache with a server pool, see [Using Connection Pools](../connection-pools/connection-pools.html). The example below shows a `cache.xml` file that creates a region.
diff --git a/docs/geode-native-docs/client-cache/cache-ownership.html.md.erb b/docs/geode-native-docs/client-cache/cache-ownership.html.md.erb
deleted file mode 100644
index e8af29c..0000000
--- a/docs/geode-native-docs/client-cache/cache-ownership.html.md.erb
+++ /dev/null
@@ -1,28 +0,0 @@
----
-title: Local, Remote, and Distributed Caches
----
-
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-
-The *distributed system* defines how client and server processes find each other.
-
-The distributed system keeps track of its membership list and makes its members aware of the identities of the other members in the distributed system.
-
-A cache within the client is referred to as its *local cache*. All other caches in the distributed system are considered *remote caches* to the application. Every cache server and application process has its own cache. The term *distributed cache* is used to describe the union of all caches in the distributed system.
-
-
diff --git a/docs/geode-native-docs/client-cache/caches.html.md.erb b/docs/geode-native-docs/client-cache/caches.html.md.erb
index 785c3f8..cca7178 100644
--- a/docs/geode-native-docs/client-cache/caches.html.md.erb
+++ b/docs/geode-native-docs/client-cache/caches.html.md.erb
@@ -21,24 +21,120 @@ limitations under the License.
The cache is the entry point to data caching in <%=vars.product_name%>. Through the cache, clients gain access to the <%=vars.product_name%> caching framework for data loading, distribution, and maintenance.
-- **[About the Client Cache](overview-client-cache.html)**
+## <a id="about-the-client-cache"></a>About the Client Cache
- The cache consists of data regions, each of which can contain any number of entries. Region entries hold the cached data. Every entry has a key that uniquely identifies it within the region and a value where the data object is stored.
+The cache consists of data regions, each of which can contain any number of entries. Region entries hold the cached data. Every entry has a key that uniquely identifies it within the region and a value where the data object is stored.
-- **[Cache APIs](caching-apis.html)**
+The `Cache` instance allows your process to set general parameters for communication between a cache and other caches in the distributed system, and to create and access any region in the cache.
- The client has two cache APIs, `RegionService` and `Cache`.
+Regions are created from the `Cache` instance. Regions provide the entry point to the interfaces for instances of `Region` and `RegionEntry`.
-- **[Local, Remote, and Distributed Caches](cache-ownership.html)**
+### <a id="native-client-cache__section_A0F2E9EF30324736BD0D5F92FE3D1BD7" class="no-quick-link"></a>Main Features and Functionality
- The *distributed system* defines how client and cache server processes find each other.
+The client cache provides the following features and functionality.
-- **[Creating and Accessing a Cache](create-access-cache.html)**
+- Local and distributed data caching for fast access.
+- Data distribution between applications on the same or different platforms.
+- Local and remote data loading through application plug-ins.
+- Application plug-ins for synchronous and asynchronous handling of data events.
+- Automated and application-specific data eviction for freeing up space in the cache, including optional overflow to disk.
+- System message logging, and statistics gathering and archiving.
- When you create a client cache, you are creating a client cache instance. You must provide some basic configuration information such as a connection name and cache initialization parameters for the client's cache instance.
+For more information specific to your client programming language, see [C++ Client API](../cpp-caching-api/cpp-caching-api.html) or [.NET Client API](../dotnet-caching-api/dotnet-caching-api.html).
+
+
+## <a id="cache-apis"></a>Cache APIs
+
+The client has two cache APIs, `RegionService` and `Cache`.
+
+### <a id="caching-apis__section_8F81996678B64BBE94EF352527F7F006" class="no-quick-link"></a>RegionService API
+
+`RegionService` provides:
+
+- Access to existing cache regions.
+- Access to the query service for the cache, which sends queries to the servers. See [Remote Querying](../remote-querying/remote-querying.html) and [Continuous Querying](../continuous-querying/continuous-querying.html).
+
+`RegionService` is inherited by `Cache`.
+
+You do not use instances of `RegionService` except for secure client applications with many users. See [Creating Multiple Secure User Connections with RegionService](../security/createsecureconnregionservice.html).
+
+### <a id="caching-apis__section_403383B9B5044A939A89A5BBB4915452" class="no-quick-link"></a>Cache API
+
+Use the `Cache` to manage your client caches. You have one `Cache` per client.
+
+The `Cache` inherits `RegionService` and adds management of these client caching features:
+
+- Region creation.
+- Subscription keepalive management for durable clients.
+- Access to the underlying distributed system.
+- `RegionService` creation for secure access by multiple users.
+
+## <a id="local-remote-distributed-caches"></a> Local, Remote, and Distributed Caches
+
+The *distributed system* defines how client and server processes find each other.
+
+The distributed system keeps track of its membership list and makes its members aware of the identities of the other members in the distributed system.
+
+A cache within the client is referred to as its *local cache*. All other caches in the distributed system are considered *remote caches* to the application. Every cache server and application process has its own cache. The term *distributed cache* is used to describe the union of all caches in the distributed system.
+
+## <a id="creating-and-accessing-cache"></a>Creating and Accessing a Cache
+
+When you create a client cache, you are creating a client cache instance. You must provide some basic configuration information such as a connection name and cache initialization parameters for the client's cache instance.
+
+When you create a cache, you provide the following input:
+
+- **Connection name**. Used in logging to identify both the distributed system connection and the cache instance. If you do not specify a connection name, a unique (but non-descriptive) default name is assigned.
+- **`cache.xml` to initialize the cache (if the initialization is not done programmatically)**. To modify the cache structure, edit `cache.xml` in your preferred text editor. No changes to the application code are required. If you do not specify a `cache.xml` file, you need to initialize the cache programmatically.
+
+The `cache.xml` file contains XML declarations for cache, region, and region entry configuration.
+
+This XML declares server connection pools and regions:
+
+``` pre
+<cache>
+ <region name="clientRegion1" refid="PROXY">
+ <region-attributes pool-name="serverPool1"/>
+ </region>
+ <region name="clientRegion2" refid="PROXY">
+ <region-attributes pool-name="serverPool2"/>
+ </region>
+ <region name="localRegion3" refid="LOCAL"/>
+ <pool name="serverPool1">
+ <locator host="host1" port="40404"/>
+ </pool>
+ <pool name="serverPool2">
+ <locator host="host2" port="40404"/>
+ </pool>
+</cache>
+
+```
+
+When you use the regions, the client regions connect to the servers through the pools named in their configurations.
+
+This file can have any name, but is generally referred to as `cache.xml` .
+
+For a list of the parameters in the `cache.xml` file, including the XSD, see [Cache Initialization File](cache-init-file.html).
+
+To create your cache, call the `CacheFactory create` function.
+The `cache` object it returns gives access to the client caching API. For example:
+
+``` pre
+CacheFactoryPtr cacheFactory = CacheFactory::createCacheFactory();
+CachePtr cachePtr = cacheFactory->create();
+
+```
+
+**Note:** For more information on how to create a cache for C++ clients, see [Creating a Cache](../cpp-caching-api/creating-cache.html), or for .NET clients, see [Creating a Cache](../dotnet-caching-api/creating-a-cache.html).
+
+
+## <a id="closing-the-cache"></a>Closing the Cache
+
+Use the `Cache::close` function to release system resources when you finish using the cache.
+
+After the cache is closed, any further method calls on the cache or any region object result in a `CacheClosedException`.
+
+If the cache is in a durable client, you need to use the `keepalive` version of the close method. See [Disconnecting From the Server](../preserving-data/disconnecting-from-server.html).
-- **[Closing the Cache](closing-cache.html)**
- Use the `Cache::close` function to release system resources when you finish using the cache.
diff --git a/docs/geode-native-docs/client-cache/caching-apis.html.md.erb b/docs/geode-native-docs/client-cache/caching-apis.html.md.erb
deleted file mode 100644
index 1a33d67..0000000
--- a/docs/geode-native-docs/client-cache/caching-apis.html.md.erb
+++ /dev/null
@@ -1,45 +0,0 @@
----
-title: Cache APIs
----
-
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-
-The client has two cache APIs, `RegionService` and `Cache`.
-
-## <a id="caching-apis__section_8F81996678B64BBE94EF352527F7F006" class="no-quick-link"></a>RegionService API
-
-`RegionService` provides:
-
-- Access to existing cache regions.
-- Access to the query service for the cache, which sends queries to the servers. See [Remote Querying](../remote-querying/remote-querying.html) and [Continuous Querying](../continuous-querying/continuous-querying.html).
-
-`RegionService` is inherited by `Cache`.
-
-You do not use instances of `RegionService` except for secure client applications with many users. See [Creating Multiple Secure User Connections with RegionService](../security/createsecureconnregionservice.html).
-
-## <a id="caching-apis__section_403383B9B5044A939A89A5BBB4915452" class="no-quick-link"></a>Cache API
-
-Use the `Cache` to manage your client caches. You have one `Cache` per client.
-
-The `Cache` inherits `RegionService` and adds management of these client caching features:
-
-- Region creation.
-- Subscription keepalive management for durable clients.
-- Access to the underlying distributed system.
-- `RegionService` creation for secure access by multiple users.
-
diff --git a/docs/geode-native-docs/client-cache/chapter-overview.html.md.erb b/docs/geode-native-docs/client-cache/chapter-overview.html.md.erb
index c443047..2c51aef 100644
--- a/docs/geode-native-docs/client-cache/chapter-overview.html.md.erb
+++ b/docs/geode-native-docs/client-cache/chapter-overview.html.md.erb
@@ -1,5 +1,5 @@
---
-title: Configuring the Native Client Cache
+title: Configuring the Client Cache
---
<!--
@@ -31,7 +31,7 @@ The client cache provides a framework for clients to store, manage, and distribu
To ease the task of managing the structure of the cache, you can define the default <%=vars.product_name%> cache structure in an XML-based initialization file.
-- **[Regions](regions.html)**
+- **[Regions](../regions/regions.html)**
You create cache regions either programmatically or through declarative statements in the `cache.xml` file. Generally, a cache is organized and populated through a combination of the two approaches.
@@ -39,11 +39,11 @@ The client cache provides a framework for clients to store, manage, and distribu
Region entries hold cached application data. Entries are automatically managed according to region attribute settings.
-- **[Region Consistency](consistency-checking-in-regions.html)**
+- **[Region Consistency](../regions/consistency-checking-in-regions.html)**
<%=vars.product_name%> ensures that all copies of a region eventually reach a consistent state on all members and clients that host the region.
-- **[Region Attributes](region-attributes.html)**
+- **[Region Attributes](../regions/region-attributes.html)**
Region attributes govern the automated management of a region and its entries.
diff --git a/docs/geode-native-docs/client-cache/closing-cache.html.md.erb b/docs/geode-native-docs/client-cache/closing-cache.html.md.erb
deleted file mode 100644
index c795d95..0000000
--- a/docs/geode-native-docs/client-cache/closing-cache.html.md.erb
+++ /dev/null
@@ -1,28 +0,0 @@
----
-title: Closing the Cache
----
-
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-
-Use the `Cache::close` function to release system resources when you finish using the cache.
-
-After the cache is closed, any further method calls on the cache or any region object result in a `CacheClosedException`.
-
-If the cache is in a durable client, you need to use the `keepalive` version of the close method. See [Disconnecting From the Server](../preserving-data/disconnecting-from-server.html).
-
-
diff --git a/docs/geode-native-docs/client-cache/concurrency-checks-enabled.html.md.erb b/docs/geode-native-docs/client-cache/concurrency-checks-enabled.html.md.erb
index 3c85c50..e267a86 100644
--- a/docs/geode-native-docs/client-cache/concurrency-checks-enabled.html.md.erb
+++ b/docs/geode-native-docs/client-cache/concurrency-checks-enabled.html.md.erb
@@ -30,6 +30,6 @@ Optionally enable concurrency checks for the region. Example:
</region-attributes>
```
-See [Region Consistency](consistency-checking-in-regions.html) for more information.
+See [Region Consistency](../regions/consistency-checking-in-regions.html) for more information.
diff --git a/docs/geode-native-docs/client-cache/controlling-cache-size.html.md.erb b/docs/geode-native-docs/client-cache/controlling-cache-size.html.md.erb
index 52cce63..96c44e9 100644
--- a/docs/geode-native-docs/client-cache/controlling-cache-size.html.md.erb
+++ b/docs/geode-native-docs/client-cache/controlling-cache-size.html.md.erb
@@ -30,7 +30,7 @@ You can cap the size of any region with the region attribute [LruEntriesLimit](l
## <a id="controlling-cache-size__section_E59CA4D5724147DC83E8991E654AC155" class="no-quick-link"></a>Controlling Cache Size
-You can control overall cache size with the [heap-lru-limit](../setting-properties/propfile-attributes.html#attributes-gfcpp), which is set in `geode.properties`. This property sets the maximum amount of memory used for the cache, in megabytes. If a new entry causes memory to grow past this limit, the LRU algorithm is called to evict entries. Heap LRU causes eviction to occur on all regions in the cache, overriding region-level [LruEntriesLimit](lru-entries-limit.html#concept_75D723D60E0 [...]
+You can control overall cache size with the [heap-lru-limit](../configuring/sysprops.html#general-props), which is set in `geode.properties`. This property sets the maximum amount of memory used for the cache, in megabytes. If a new entry causes memory to grow past this limit, the LRU algorithm is called to evict entries. Heap LRU causes eviction to occur on all regions in the cache, overriding region-level [LruEntriesLimit](lru-entries-limit.html#concept_75D723D60E044FF9AE97C939699AB10A [...]
For each region, evictions are performed according to the region's `DiskPolicy` and `PersistenceManager` settings. If you use `heap-lru-limit`, review these region attributes for all your caching regions, to be sure you are evicting the way you want to.
diff --git a/docs/geode-native-docs/client-cache/create-access-cache.html.md.erb b/docs/geode-native-docs/client-cache/create-access-cache.html.md.erb
deleted file mode 100644
index 7ceb126..0000000
--- a/docs/geode-native-docs/client-cache/create-access-cache.html.md.erb
+++ /dev/null
@@ -1,69 +0,0 @@
----
-title: Creating and Accessing a Cache
----
-
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-
-When you create a client cache, you are creating a client cache instance. You must provide some basic configuration information such as a connection name and cache initialization parameters for the client's cache instance.
-
-When you create a cache, you provide the following input:
-
-- **Connection name**. Used in logging to identify both the distributed system connection and the cache instance. If you do not specify a connection name, a unique (but non-descriptive) default name is assigned.
-- **`cache.xml` to initialize the cache (if the initialization is not done programmatically)**. To modify the cache structure, edit `cache.xml` in your preferred text editor. No changes to the application code are required. If you do not specify a `cache.xml` file, you need to initialize the cache programmatically.
-
-The `cache.xml` file contains XML declarations for cache, region, and region entry configuration.
-
-This XML declares server connection pools and regions:
-
-``` pre
-<cache>
- <region name="clientRegion1" refid="PROXY">
- <region-attributes pool-name="serverPool1"/>
- </region>
- <region name="clientRegion2" refid="PROXY">
- <region-attributes pool-name="serverPool2"/>
- </region>
- <region name="localRegion3" refid="LOCAL"/>
- <pool name="serverPool1">
- <locator host="host1" port="40404"/>
- </pool>
- <pool name="serverPool2">
- <locator host="host2" port="40404"/>
- </pool>
-</cache>
-
-```
-
-When you use the regions, the client regions connect to the servers through the pools named in their configurations.
-
-This file can have any name, but is generally referred to as `cache.xml` .
-
-For a list of the parameters in the `cache.xml` file, including the XSD, see [Cache Initialization File](cache-init-file.html).
-
-To create your cache, call the `CacheFactory create` function.
-The `cache` object it returns gives access to the client caching API. For example:
-
-``` pre
-CacheFactoryPtr cacheFactory = CacheFactory::createCacheFactory();
-CachePtr cachePtr = cacheFactory->create();
-
-```
-
-**Note:** For more information on how to create a cache for C++ clients, see [Creating a Cache](../cpp-caching-api/creating-cache.html), or for .NET clients, see [Creating a Cache](../dotnet-caching-api/creating-a-cache.html).
-
-
diff --git a/docs/geode-native-docs/client-cache/overview-client-cache.html.md.erb b/docs/geode-native-docs/client-cache/overview-client-cache.html.md.erb
deleted file mode 100644
index dbd6d9e..0000000
--- a/docs/geode-native-docs/client-cache/overview-client-cache.html.md.erb
+++ /dev/null
@@ -1,41 +0,0 @@
----
-title: About the Client Cache
----
-
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-
-The cache consists of data regions, each of which can contain any number of entries. Region entries hold the cached data. Every entry has a key that uniquely identifies it within the region and a value where the data object is stored.
-
-The `Cache` instance allows your process to set general parameters for communication between a cache and other caches in the distributed system, and to create and access any region in the cache.
-
-Regions are created from the `Cache` instance. Regions provide the entry point to the interfaces for instances of `Region` and `RegionEntry`.
-
-## <a id="native-client-cache__section_A0F2E9EF30324736BD0D5F92FE3D1BD7" class="no-quick-link"></a>Main Features and Functionality
-
-The client cache provides the following features and functionality.
-
-- Local and distributed data caching for fast access.
-- Data distribution between applications on the same or different platforms.
-- Local and remote data loading through application plug-ins.
-- Application plug-ins for synchronous and asynchronous handling of data events.
-- Automated and application-specific data eviction for freeing up space in the cache, including optional overflow to disk.
-- System message logging, and statistics gathering and archiving.
-
-For more information specific to your client programming language, see [C++ Client API](../cpp-caching-api/cpp-caching-api.html) or [.NET Client API](../dotnet-caching-api/dotnet-caching-api.html).
-
-
diff --git a/docs/geode-native-docs/configuring/client-config-notes.txt b/docs/geode-native-docs/configuring/client-config-notes.txt
new file mode 100644
index 0000000..1a32ad3
--- /dev/null
+++ b/docs/geode-native-docs/configuring/client-config-notes.txt
@@ -0,0 +1,28 @@
+4/23/2018
+Dave & Ivan
+
+Thick vs thin client
+
+Cache & region config - client-specific?
+
+See API docs for publicly accessible props.
+
+Eleveate to higher position:
+ Local, Remote, and Distributed Caches
+
+connection name vs pool name
+
+General steps:
+
+- Start w/ cacheFactory , create a cache
+
+- From the cache Get a poolFactory, configure, create a pool
+
+- From the cache, create a regionFactory (incl type of region), configure (incl reference to pool), create a region
+
+- operate on region
+(cf C++ examples for simple version)
+
+
+
+
diff --git a/docs/geode-native-docs/configuring/configuration.html.md.erb b/docs/geode-native-docs/configuring/configuration.html.md.erb
index 84924d3..b5138ed 100644
--- a/docs/geode-native-docs/configuring/configuration.html.md.erb
+++ b/docs/geode-native-docs/configuring/configuration.html.md.erb
@@ -1,7 +1,8 @@
---
-title: Native Client Configuration
+title: Configuring the Client
---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/docs/geode-native-docs/configuring/sysprops.html.md.erb b/docs/geode-native-docs/configuring/sysprops.html.md.erb
index 5aa7634..423fd3b 100644
--- a/docs/geode-native-docs/configuring/sysprops.html.md.erb
+++ b/docs/geode-native-docs/configuring/sysprops.html.md.erb
@@ -27,7 +27,7 @@ A variety of system properties can be specified when a client connects to a dist
The following settings can be configured:
-- **[General Properties](#attributes-gfcpp__table_general_props)** Basic information for the process, such as cache creation parameters.
+- **[General Properties](#general_props)** Basic information for the process, such as cache creation parameters.
- **[Logging Properties](#attributes-gfcpp__table_logging_props)** How and where to log system messages.
- **[Statistics Archiving Properties](#attributes-gfcpp__table_statistic_props)** How to collect and archive statistics information.
- **[Durable Client Properties](#attributes-gfcpp__table_durable_client_props)** Information about the durable clients connected to the system.
@@ -38,7 +38,7 @@ The following settings can be configured:
The following tables list attributes that can be specified programmatically or stored in the `geode.properties` file to be read by a client.
-<a id="attributes-gfcpp__table_general_props" class="no-quick-link"></a>
+<a id="general_props" class="no-quick-link"></a>
<table>
<caption><span class="tablecap">General Properties</span></caption>
diff --git a/docs/geode-native-docs/client-cache/consistency-checking-in-regions.html.md.erb b/docs/geode-native-docs/regions/consistency-checking-in-regions.html.md.erb
similarity index 100%
rename from docs/geode-native-docs/client-cache/consistency-checking-in-regions.html.md.erb
rename to docs/geode-native-docs/regions/consistency-checking-in-regions.html.md.erb
diff --git a/docs/geode-native-docs/client-cache/declarative-region-creation.html.md.erb b/docs/geode-native-docs/regions/declarative-region-creation.html.md.erb
similarity index 96%
rename from docs/geode-native-docs/client-cache/declarative-region-creation.html.md.erb
rename to docs/geode-native-docs/regions/declarative-region-creation.html.md.erb
index 41806a5..15ccc7a 100644
--- a/docs/geode-native-docs/client-cache/declarative-region-creation.html.md.erb
+++ b/docs/geode-native-docs/regions/declarative-region-creation.html.md.erb
@@ -48,5 +48,5 @@ Regions are placed inside the cache declaration in `region` elements. For exampl
```
-The `cache.xml` file contents must conform to the XML described at [http://geode.apache.org/schema/cache/cache-1.0.xsd](http://geode.apache.org/schema/cache/cache-1.0.xsd). For details, see [Cache Initialization File](cache-init-file.html).
+The `cache.xml` file contents must conform to the XML described at [http://geode.apache.org/schema/cache/cache-1.0.xsd](http://geode.apache.org/schema/cache/cache-1.0.xsd). For details, see [Cache Initialization File](../client-cache/cache-init-file.html).
diff --git a/docs/geode-native-docs/client-cache/getting-the-region-size.html.md.erb b/docs/geode-native-docs/regions/getting-the-region-size.html.md.erb
similarity index 100%
rename from docs/geode-native-docs/client-cache/getting-the-region-size.html.md.erb
rename to docs/geode-native-docs/regions/getting-the-region-size.html.md.erb
diff --git a/docs/geode-native-docs/client-cache/invalidating-region.html.md.erb b/docs/geode-native-docs/regions/invalidating-region.html.md.erb
similarity index 100%
rename from docs/geode-native-docs/client-cache/invalidating-region.html.md.erb
rename to docs/geode-native-docs/regions/invalidating-region.html.md.erb
diff --git a/docs/geode-native-docs/client-cache/programmatic-region-creation.html.md.erb b/docs/geode-native-docs/regions/programmatic-region-creation.html.md.erb
similarity index 100%
rename from docs/geode-native-docs/client-cache/programmatic-region-creation.html.md.erb
rename to docs/geode-native-docs/regions/programmatic-region-creation.html.md.erb
diff --git a/docs/geode-native-docs/client-cache/region-access.html.md.erb b/docs/geode-native-docs/regions/region-access.html.md.erb
similarity index 100%
rename from docs/geode-native-docs/client-cache/region-access.html.md.erb
rename to docs/geode-native-docs/regions/region-access.html.md.erb
diff --git a/docs/geode-native-docs/client-cache/region-attributes-desc.html.md.erb b/docs/geode-native-docs/regions/region-attributes-desc.html.md.erb
similarity index 100%
rename from docs/geode-native-docs/client-cache/region-attributes-desc.html.md.erb
rename to docs/geode-native-docs/regions/region-attributes-desc.html.md.erb
diff --git a/docs/geode-native-docs/client-cache/region-attributes.html.md.erb b/docs/geode-native-docs/regions/region-attributes.html.md.erb
similarity index 67%
rename from docs/geode-native-docs/client-cache/region-attributes.html.md.erb
rename to docs/geode-native-docs/regions/region-attributes.html.md.erb
index 5e272d3..a2fea28 100644
--- a/docs/geode-native-docs/client-cache/region-attributes.html.md.erb
+++ b/docs/geode-native-docs/regions/region-attributes.html.md.erb
@@ -29,22 +29,22 @@ Region attribute settings determine where the data resides, how the region is ma
- **[Mutable and Immutable Region Attributes](region-attributes-desc.html)**
-- **[CachingEnabled](caching-enabled.html)**
+- **[CachingEnabled](../client-cache/caching-enabled.html)**
-- **[InitialCapacity](initial-capacity.html)**
+- **[InitialCapacity](../client-cache/initial-capacity.html)**
-- **[LoadFactor](load-factor.html)**
+- **[LoadFactor](../client-cache/load-factor.html)**
-- **[ConcurrencyLevel](concurrency-level.html)**
+- **[ConcurrencyLevel](../client-cache/concurrency-level.html)**
-- **[ConcurrencyChecksEnabled](concurrency-checks-enabled.html)**
+- **[ConcurrencyChecksEnabled](../client-cache/concurrency-checks-enabled.html)**
-- **[LruEntriesLimit](lru-entries-limit.html)**
+- **[LruEntriesLimit](../client-cache/lru-entries-limit.html)**
-- **[DiskPolicy](disk-policy.html)**
+- **[DiskPolicy](../client-cache/disk-policy.html)**
-- **[PersistenceManager](persistence-manager.html)**
+- **[PersistenceManager](../client-cache/persistence-manager.html)**
-- **[Specifying Expiration Attributes](expiration-attributes.html)**
+- **[Specifying Expiration Attributes](../client-cache/expiration-attributes.html)**
diff --git a/docs/geode-native-docs/client-cache/region-shortcuts.html.md.erb b/docs/geode-native-docs/regions/region-shortcuts.html.md.erb
similarity index 100%
rename from docs/geode-native-docs/client-cache/region-shortcuts.html.md.erb
rename to docs/geode-native-docs/regions/region-shortcuts.html.md.erb
diff --git a/docs/geode-native-docs/client-cache/regions.html.md.erb b/docs/geode-native-docs/regions/regions.html.md.erb
similarity index 100%
rename from docs/geode-native-docs/client-cache/regions.html.md.erb
rename to docs/geode-native-docs/regions/regions.html.md.erb
diff --git a/docs/geode-native-docs/client-cache/specify-region-attributes.html.md.erb b/docs/geode-native-docs/regions/specify-region-attributes.html.md.erb
similarity index 100%
rename from docs/geode-native-docs/client-cache/specify-region-attributes.html.md.erb
rename to docs/geode-native-docs/regions/specify-region-attributes.html.md.erb
--
To stop receiving notification emails like this one, please contact
dbarnes@apache.org.