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 2022/02/24 21:06:00 UTC

[geode-native] branch feature/GEODE-10062 created (now c5d81c1)

This is an automated email from the ASF dual-hosted git repository.

dbarnes pushed a change to branch feature/GEODE-10062
in repository https://gitbox.apache.org/repos/asf/geode-native.git.


      at c5d81c1  GEODE-10062: Update Native Client Docs to minimize redirects - additions and corrections

This branch includes the following new commits:

     new c5d81c1  GEODE-10062: Update Native Client Docs to minimize redirects - additions and corrections

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


[geode-native] 01/01: GEODE-10062: Update Native Client Docs to minimize redirects - additions and corrections

Posted by db...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

dbarnes pushed a commit to branch feature/GEODE-10062
in repository https://gitbox.apache.org/repos/asf/geode-native.git

commit c5d81c18a1922f08d9e78fd6a422e0409342293d
Author: Dave Barnes <db...@apache.org>
AuthorDate: Thu Feb 24 12:55:22 2022 -0800

    GEODE-10062: Update Native Client Docs to minimize redirects - additions and corrections
---
 docs/geode-native-docs-cpp/client-cache-ref.html.md.erb        | 10 +++++-----
 docs/geode-native-docs-cpp/configuring/sysprops.html.md.erb    |  2 +-
 .../getting-started/app-dev-walkthrough-cpp.html.md.erb        |  2 +-
 docs/geode-native-docs-dotnet/client-cache-ref.html.md.erb     | 10 +++++-----
 docs/geode-native-docs-dotnet/configuring/sysprops.html.md.erb |  2 +-
 .../getting-started/app-dev-walkthrough-dotnet.html.md.erb     |  7 ++++---
 6 files changed, 17 insertions(+), 16 deletions(-)

diff --git a/docs/geode-native-docs-cpp/client-cache-ref.html.md.erb b/docs/geode-native-docs-cpp/client-cache-ref.html.md.erb
index 7e398a6..250caad 100644
--- a/docs/geode-native-docs-cpp/client-cache-ref.html.md.erb
+++ b/docs/geode-native-docs-cpp/client-cache-ref.html.md.erb
@@ -364,7 +364,7 @@ Take into account that if `library-name` is not specified, the function will be
 
 A partition resolver is used for single-hop access to partitioned region entries on the server side. This resolver
 implementation must match that of the `PartitionResolver` on the server side.
-See the [API Class Reference](/<%=vars.cppapiref_version%>/hierarchy.html) for the **PartitionResolver** class.
+See the [API Class Reference](<%=vars.cppapiref_version%>/hierarchy.html) for the **PartitionResolver** class.
 
 For example:
 
@@ -378,28 +378,28 @@ For example:
 
 \<cache-loader\> identifies a cache loader function by specifying `library-function-name` and optionally a `library-name`.
 Take into account that if `library-name` is not specified, the function will be looked for in the application itself.
-See the [API Class Reference](/<%=vars.cppapiref_version%>/hierarchy.html) for the **CacheLoader** class.
+See the [API Class Reference](<%=vars.cppapiref_version%>/hierarchy.html) for the **CacheLoader** class.
 
 <a id="cache-listener-ref"></a>
 ## \<cache-listener\>
 
 \<cache-listener\> identifies a cache listener function by specifying `library-function-name` and optionally a `library-name`.
 Take into account that if `library-name` is not specified, the function will be looked for in the application itself.
-See the [API Class Reference](/<%=vars.cppapiref_version%>/hierarchy.html) for the **CacheListener** class.
+See the [API Class Reference](<%=vars.cppapiref_version%>/hierarchy.html) for the **CacheListener** class.
 
 <a id="cache-writer-ref"></a>
 ## \<cache-writer\>
 
 \<cache-writer\> identifies a cache writer function by specifying `library-function-name` and optionally a `library-name`.
 Take into account that if `library-name` is not specified, the function will be looked for in the application itself.
-See the [API Class Reference](/<%=vars.cppapiref_version%>/hierarchy.html) for the **CacheWriter** class.
+See the [API Class Reference](<%=vars.cppapiref_version%>/hierarchy.html) for the **CacheWriter** class.
 
 <a id="persistence-manager-ref"></a>
 ## \<persistence-manager\>
 
 For each region, if the disk-policy attribute is set to `overflows`, a persistence-manager plug-in
 must perform cache-to-disk and disk-to-cache operations.
-See the [API Class Reference](/<%=vars.cppapiref_version%>/hierarchy.html) for the **PersistenceManager** class.
+See the [API Class Reference](<%=vars.cppapiref_version%>/hierarchy.html) for the **PersistenceManager** class.
 
 \<persistence-manager\> identifies a persistence manager function by specifying `library-function-name` and optionally a `library-name`.
 Take into account that if `library-name` is not specified, the function will be looked for in the application itself.
diff --git a/docs/geode-native-docs-cpp/configuring/sysprops.html.md.erb b/docs/geode-native-docs-cpp/configuring/sysprops.html.md.erb
index 7a1ec63..a01b0b1 100644
--- a/docs/geode-native-docs-cpp/configuring/sysprops.html.md.erb
+++ b/docs/geode-native-docs-cpp/configuring/sysprops.html.md.erb
@@ -20,7 +20,7 @@ limitations under the License.
 -->
 
 A variety of system properties can be specified when a client connects to a distributed system, either programmatically or in a `geode.properties` file.
-See `apache::geode::client::SystemProperties` in the [C++ API docs](cppdocs).
+See `apache::geode::client::SystemProperties` in the [C++ API docs](<%=vars.cppapiref%>/hierarchy.html).
 
 The following settings can be configured:
 
diff --git a/docs/geode-native-docs-cpp/getting-started/app-dev-walkthrough-cpp.html.md.erb b/docs/geode-native-docs-cpp/getting-started/app-dev-walkthrough-cpp.html.md.erb
index 13a109b..20e7bfd 100644
--- a/docs/geode-native-docs-cpp/getting-started/app-dev-walkthrough-cpp.html.md.erb
+++ b/docs/geode-native-docs-cpp/getting-started/app-dev-walkthrough-cpp.html.md.erb
@@ -34,7 +34,7 @@ This walkthrough assumes that certain components are in place:
 | Windows | C:\Program Files\nativeclient |
 
 
-- The **CMake** tool suite. Download and install CMake, following the instructions on [cmake.org] (https://cmake.org).
+- The **CMake** tool suite. Download and install CMake, following the instructions on [cmake.org](https://cmake.org).
 
 - **Geode**: Install and configure Geode. See the [_Geode User's Guide_](http://geode.apache.org/docs/) for instructions and system requirements.
 
diff --git a/docs/geode-native-docs-dotnet/client-cache-ref.html.md.erb b/docs/geode-native-docs-dotnet/client-cache-ref.html.md.erb
index 60fa610..35bcbbd 100644
--- a/docs/geode-native-docs-dotnet/client-cache-ref.html.md.erb
+++ b/docs/geode-native-docs-dotnet/client-cache-ref.html.md.erb
@@ -357,7 +357,7 @@ Use the `<expiration-attributes>` sub-element to specify duration and expiration
 
 A partition resolver is used for single-hop access to partitioned region entries on the server side. This resolver
 implementation must match that of the `PartitionResolver` on the server side.
-See the [API Class Reference](/<%=vars.dotnetapiref_version%>/hierarchy.html) for the **PartitionResolver** class.
+See the [API Class Reference](<%=vars.dotnetapiref_version%>/hierarchy.html) for the **PartitionResolver** class.
 
 For example:
 
@@ -370,26 +370,26 @@ For example:
 ## \<cache-loader\>
 
 \<cache-loader\> identifies a cache loader function by specifying `library-name` and `library-function-name`.
-See the [API Class Reference](/<%=vars.dotnetapiref_version%>/hierarchy.html) for the **CacheLoader** class.
+See the [API Class Reference](<%=vars.dotnetapiref_version%>/hierarchy.html) for the **CacheLoader** class.
 
 <a id="cache-listener-ref"></a>
 ## \<cache-listener\>
 
 \<cache-listener\> identifies a cache listener function by specifying `library-name` and `library-function-name`.
-See the [API Class Reference](/<%=vars.dotnetapiref_version%>/hierarchy.html) for the **CacheListener** class.
+See the [API Class Reference](<%=vars.dotnetapiref_version%>/hierarchy.html) for the **CacheListener** class.
 
 <a id="cache-writer-ref"></a>
 ## \<cache-writer\>
 
 \<cache-writer\> identifies a cache writer function by specifying `library-name` and `library-function-name`.
-See the [API Class Reference](/<%=vars.dotnetapiref_version%>/hierarchy.html) for the **CacheWriter** class.
+See the [API Class Reference](<%=vars.dotnetapiref_version%>/hierarchy.html) for the **CacheWriter** class.
 
 <a id="persistence-manager-ref"></a>
 ## \<persistence-manager\>
 
 For each region, if the disk-policy attribute is set to `overflows`, a persistence-manager plug-in
 must perform cache-to-disk and disk-to-cache operations.
-See the [API Class Reference](/<%=vars.dotnetapiref_version%>/hierarchy.html) for the **PersistenceManager** class.
+See the [API Class Reference](<%=vars.dotnetapiref_version%>/hierarchy.html) for the **PersistenceManager** class.
 
 \<persistence-manager\> identifies a persistence manager function by specifying `library-name` and `library-function-name`.
 You can also specify a set of properties to be passed to the function as parameters.
diff --git a/docs/geode-native-docs-dotnet/configuring/sysprops.html.md.erb b/docs/geode-native-docs-dotnet/configuring/sysprops.html.md.erb
index f6cbf51..aba2185 100644
--- a/docs/geode-native-docs-dotnet/configuring/sysprops.html.md.erb
+++ b/docs/geode-native-docs-dotnet/configuring/sysprops.html.md.erb
@@ -20,7 +20,7 @@ limitations under the License.
 -->
 
 A variety of system properties can be specified when a client connects to a distributed system, either programmatically or in a `geode.properties` file.
-See `Apache::Geode::Client::SystemProperties` in the [.NET API docs](dotnetdocs).
+See `Apache::Geode::Client::SystemProperties` in the [.NET API docs](<%=vars.dotnetapiref%>/hierarchy.html).
 
 The following settings can be configured:
 
diff --git a/docs/geode-native-docs-dotnet/getting-started/app-dev-walkthrough-dotnet.html.md.erb b/docs/geode-native-docs-dotnet/getting-started/app-dev-walkthrough-dotnet.html.md.erb
index 9896edc..5245ac0 100644
--- a/docs/geode-native-docs-dotnet/getting-started/app-dev-walkthrough-dotnet.html.md.erb
+++ b/docs/geode-native-docs-dotnet/getting-started/app-dev-walkthrough-dotnet.html.md.erb
@@ -2,6 +2,7 @@
 title:  .NET Application Development Walkthrough
 ---
 
+
 <!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
@@ -28,7 +29,7 @@ This walkthrough assumes that certain components are in place:
   [Getting Started with the Native Library](getting-started-nc-client.html). Follow the ease-of-use
   recommendations by installing the Native Client in `C:\Program Files\nativeclient`.
 
-- The **CMake** tool suite. Download and install CMake, following the instructions on [cmake.org] (https://cmake.org).
+- The **CMake** tool suite. Download and install CMake, following the instructions on [cmake.org](https://cmake.org).
 
 - **Geode**: Install and configure Geode. See the [_Geode User's Guide_](http://geode.apache.org/docs/) for instructions and system requirements.
 
@@ -97,7 +98,7 @@ should contain the following CMake instructions:
 
     set_target_properties(MyProject PROPERTIES
         VS_DOTNET_TARGET_FRAMEWORK_VERSION "v4.5.2"
-        VS_DOTNET_REFERENCES "System;${<%=vars.product_name%>Native_DOTNET_LIBRARY}")
+        VS_DOTNET_REFERENCES "System;{GemFireNative_DOTNET_LIBRARY})
     ```
 
 Combined, the above elements comprise the following CMakeLists.txt:
@@ -120,7 +121,7 @@ target_link_libraries(MyProject
 
 set_target_properties(MyProject PROPERTIES
     VS_DOTNET_TARGET_FRAMEWORK_VERSION "v4.5.2"
-    VS_DOTNET_REFERENCES "System;${<%=vars.product_name%>Native_DOTNET_LIBRARY}")
+    VS_DOTNET_REFERENCES "System;${GemFireNative_DOTNET_LIBRARY}")
 ```
 
 ## <a id="building_the_app_dotnet"></a>Configuring the App