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 87891bd GEODE-10062: Update Native Client Docs to minimize redirects (#931) 87891bd is described below commit 87891bd2b3ab3741a98f2c2e7aa4d4785f05cc3f Author: Dave Barnes <dbar...@apache.org> AuthorDate: Thu Feb 24 09:03:30 2022 -0800 GEODE-10062: Update Native Client Docs to minimize redirects (#931) --- docs/geode-native-book-cpp/config.yml | 5 +++++ docs/geode-native-book-dotnet/config.yml | 5 +++++ docs/geode-native-docs-cpp/about-client-users-guide.html.md.erb | 2 +- .../configuring/config-client-cache.html.md.erb | 2 +- docs/geode-native-docs-cpp/configuring/configuration.html.md.erb | 2 +- .../connection-pools/subscription-properties.html.md.erb | 2 +- docs/geode-native-docs-cpp/continuous-queries.html.md.erb | 6 +++--- docs/geode-native-docs-cpp/function-execution.html.md.erb | 2 +- .../getting-started/getting-started-nc-client.html.md.erb | 6 +++--- docs/geode-native-docs-cpp/regions/regions.html.md.erb | 2 +- docs/geode-native-docs-cpp/remote-queries.html.md.erb | 4 ++-- docs/geode-native-docs-cpp/security/authentication.html.md.erb | 2 +- docs/geode-native-docs-cpp/security/security.html.md.erb | 2 +- docs/geode-native-docs-cpp/security/sslclientserver.html.md.erb | 4 ++-- .../serialization/data-serialization.html.md.erb | 2 +- docs/geode-native-docs-cpp/transactions.html.md.erb | 2 +- docs/geode-native-docs-dotnet/about-client-users-guide.html.md.erb | 2 +- .../configuring/config-client-cache.html.md.erb | 2 +- docs/geode-native-docs-dotnet/configuring/configuration.html.md.erb | 2 +- .../connection-pools/subscription-properties.html.md.erb | 2 +- docs/geode-native-docs-dotnet/continuous-queries.html.md.erb | 6 +++--- docs/geode-native-docs-dotnet/function-execution.html.md.erb | 2 +- .../getting-started/getting-started-nc-client.html.md.erb | 6 +++--- .../preserving-data/configuring-durable-nc.html.md.erb | 2 +- .../preserving-data/durable-client-messaging-req.html.md.erb | 2 +- .../preserving-data/high-availability-client-server.html.md.erb | 2 +- .../impl-cache-listeners-durable-clients.html.md.erb | 2 +- .../preserving-data/using-queue-conflation.html.md.erb | 2 +- docs/geode-native-docs-dotnet/regions/regions.html.md.erb | 2 +- docs/geode-native-docs-dotnet/remote-queries.html.md.erb | 4 ++-- docs/geode-native-docs-dotnet/security/authentication.html.md.erb | 2 +- docs/geode-native-docs-dotnet/security/security.html.md.erb | 2 +- docs/geode-native-docs-dotnet/security/sslclientserver.html.md.erb | 4 ++-- .../serialization/data-serialization.html.md.erb | 2 +- docs/geode-native-docs-dotnet/transactions.html.md.erb | 2 +- 35 files changed, 55 insertions(+), 45 deletions(-) diff --git a/docs/geode-native-book-cpp/config.yml b/docs/geode-native-book-cpp/config.yml index ae90968..1040524 100644 --- a/docs/geode-native-book-cpp/config.yml +++ b/docs/geode-native-book-cpp/config.yml @@ -49,5 +49,10 @@ template_variables: book_title_short: Geode Native C++ Docs local_header_title: Apache Geode Native C++ local_header_img: /images/Apache_Geode_logo_symbol.png + serverman: https://geode.apache.org/docs/guide/latest + geodeman: https://geode.apache.org/docs/guide/latest + cppapiref: https://geode.apache.org/releases/latest/cppdocs/ + dotnetapiref: https://geode.apache.org/releases/latest/dotnetdocs/ + javaapiref: https://geode.apache.org/releases/latest/javadoc/index.html broken_link_exclusions: iefix|using_custom_classes|arrowhead|cppdocs|dotnetdocs|# diff --git a/docs/geode-native-book-dotnet/config.yml b/docs/geode-native-book-dotnet/config.yml index e02f681..1f2cdb9 100644 --- a/docs/geode-native-book-dotnet/config.yml +++ b/docs/geode-native-book-dotnet/config.yml @@ -49,5 +49,10 @@ template_variables: book_title_short: Geode Native .NET Docs local_header_title: Apache Geode Native .NET local_header_img: /images/Apache_Geode_logo_symbol.png + serverman: https://geode.apache.org/docs/guide/latest + geodeman: https://geode.apache.org/docs/guide/latest + cppapiref: https://geode.apache.org/releases/latest/cppdocs/ + dotnetapiref: https://geode.apache.org/releases/latest/dotnetdocs/ + javaapiref: https://geode.apache.org/releases/latest/javadoc/index.html broken_link_exclusions: iefix|using_custom_classes|arrowhead|cppdocs|dotnetdocs|# diff --git a/docs/geode-native-docs-cpp/about-client-users-guide.html.md.erb b/docs/geode-native-docs-cpp/about-client-users-guide.html.md.erb index 3e33c1c..b7876ab 100644 --- a/docs/geode-native-docs-cpp/about-client-users-guide.html.md.erb +++ b/docs/geode-native-docs-cpp/about-client-users-guide.html.md.erb @@ -28,5 +28,5 @@ See the API docs for API details: - [C++ API docs](/<%=vars.cppapiref_version%>/hierarchy.html) - [.NET API docs](/<%=vars.dotnetapiref_version%>/hierarchy.html) -See the [_<%=vars.product_name_long%> User Guide_](serverman/about_<%=vars.product_name.downcase%>.html) for information regarding the server. +See the [_<%=vars.product_name_long%> User Guide_](<%=vars.serverman%>/about_<%=vars.product_name.downcase%>.html) for information regarding the server. diff --git a/docs/geode-native-docs-cpp/configuring/config-client-cache.html.md.erb b/docs/geode-native-docs-cpp/configuring/config-client-cache.html.md.erb index 6f502cb..bbad195 100644 --- a/docs/geode-native-docs-cpp/configuring/config-client-cache.html.md.erb +++ b/docs/geode-native-docs-cpp/configuring/config-client-cache.html.md.erb @@ -32,4 +32,4 @@ Regions are created from `Cache` instances. Regions provide the entry points to instances of `Region` and `RegionEntry`. For more information specific to your client programming language, see the -[C++ Client API](/cppapiref/hierarchy.html). +[C++ Client API](<%=vars.cppapiref%>/hierarchy.html). diff --git a/docs/geode-native-docs-cpp/configuring/configuration.html.md.erb b/docs/geode-native-docs-cpp/configuring/configuration.html.md.erb index 7db11a1..fc00a68 100644 --- a/docs/geode-native-docs-cpp/configuring/configuration.html.md.erb +++ b/docs/geode-native-docs-cpp/configuring/configuration.html.md.erb @@ -71,6 +71,6 @@ When redundancy is enabled, secondary servers maintain queue backups while the p events to the client. If the primary server fails, one of the secondary servers steps in as primary to provide uninterrupted event messaging to the client. To configure high availability, set the `subscription-redundancy` in the client’s pool configuration. This setting indicates the number of secondary servers to use. -See the _<%=vars.product_name%> User Guide_ section [Configuring Highly Available Servers](serverman/developing/events/configuring_highly_available_servers.html) +See the _<%=vars.product_name%> User Guide_ section [Configuring Highly Available Servers](<%=vars.serverman%>/developing/events/configuring_highly_available_servers.html) for more details. diff --git a/docs/geode-native-docs-cpp/connection-pools/subscription-properties.html.md.erb b/docs/geode-native-docs-cpp/connection-pools/subscription-properties.html.md.erb index 53f4fbc..e670f95 100644 --- a/docs/geode-native-docs-cpp/connection-pools/subscription-properties.html.md.erb +++ b/docs/geode-native-docs-cpp/connection-pools/subscription-properties.html.md.erb @@ -23,7 +23,7 @@ Each connection pool has a single subscription connection that can be to any ser When a client registers interest for a region, if the connection pool does not already have a subscription channel, the connection pool sends a message to the server locator, and the server locator chooses servers to host the queue and return those server names to the client. The client then contacts the chosen servers and asks them to create the queue. -The client maintains at least one connection with each server hosting a queue. If the server does not detect any connections from a non-durable client, it drops the client queue and closes all artifacts for the client. For information about durable client subscriptions, see [Implementing Durable Client/Server Messaging](/serverman/developing/events/implementing_durable_client_server_messaging.html). +The client maintains at least one connection with each server hosting a queue. If the server does not detect any connections from a non-durable client, it drops the client queue and closes all artifacts for the client. For information about durable client subscriptions, see [Implementing Durable Client/Server Messaging](<%=vars.serverman%>/developing/events/implementing_durable_client_server_messaging.html). ## <a id="subscription-properties__section_294BD33FBDC6454FAD9C5118829EBBA4" class="no-quick-link"></a>Requesting a Subscription Region Queue diff --git a/docs/geode-native-docs-cpp/continuous-queries.html.md.erb b/docs/geode-native-docs-cpp/continuous-queries.html.md.erb index 5e12670..6d01d8d 100644 --- a/docs/geode-native-docs-cpp/continuous-queries.html.md.erb +++ b/docs/geode-native-docs-cpp/continuous-queries.html.md.erb @@ -21,7 +21,7 @@ limitations under the License. The C++ and .NET clients can initiate queries that run on the <%=vars.product_name%> cache server and notify the client when the query results have changed. For details on the server-side setup for -continuous queries, see [How Continuous Querying Works](serverman/developing/continuous_querying/how_continuous_querying_works.html) +continuous queries, see [How Continuous Querying Works](<%=vars.serverman%>/developing/continuous_querying/how_continuous_querying_works.html) in the *<%=vars.product_name%> User Guide*. ## <a id="cq_main_features" ></a>Continuous Query Basics @@ -37,8 +37,8 @@ to process CQ events is based on the standard <%=vars.product_name%> event handl server-to-client messaging mechanisms to send events. All tuning of your server-to-client messaging also tunes the messaging of your CQ events. If your system is configured for high availability then your CQs are highly available, with seamless failover provided in case of -server failure (see [Highly Available Client/Server Event Messaging](/serverman/developing/events/ha_event_messaging_whats_next.html)). -If your clients are durable, you can also define any of your CQs as durable (see [Implementing Durable Client/Server Messaging](/serverman/developing/events/implementing_durable_client_server_messaging.html)). +server failure (see [Highly Available Client/Server Event Messaging](<%=vars.serverman%>/developing/events/ha_event_messaging_whats_next.html)). +If your clients are durable, you can also define any of your CQs as durable (see [Implementing Durable Client/Server Messaging](<%=vars.serverman%>/developing/events/implementing_durable_client_server_messaging.html)). - **Interest criteria based on data values**. Continuous queries are run against the region's entry values. Compare this to register interest by reviewing [Registering Interest for Entries](regions/registering-interest-for-entries.html). diff --git a/docs/geode-native-docs-cpp/function-execution.html.md.erb b/docs/geode-native-docs-cpp/function-execution.html.md.erb index 00cc262..bf01b17 100644 --- a/docs/geode-native-docs-cpp/function-execution.html.md.erb +++ b/docs/geode-native-docs-cpp/function-execution.html.md.erb @@ -28,7 +28,7 @@ To be callable from your client, a function must be - resident on the server, and - registered as available for client access. -See [Executing a Function in <%=vars.product_name_long%>](serverman/developing/function_exec/function_execution.html) +See [Executing a Function in <%=vars.product_name_long%>](<%=vars.serverman%>/developing/function_exec/function_execution.html) in the <%=vars.product_name%> User Guide for details on how to write and register server-resident functions. ## <a id="nc-fe-client_side_requirements"></a>Client-side Requirements diff --git a/docs/geode-native-docs-cpp/getting-started/getting-started-nc-client.html.md.erb b/docs/geode-native-docs-cpp/getting-started/getting-started-nc-client.html.md.erb index 4be7ba7..1b5c779 100644 --- a/docs/geode-native-docs-cpp/getting-started/getting-started-nc-client.html.md.erb +++ b/docs/geode-native-docs-cpp/getting-started/getting-started-nc-client.html.md.erb @@ -44,8 +44,8 @@ You can choose whether to use a large, remote, production-quality cluster; a sma 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) -and [Client/Server Configuration](serverman/topologies_and_comm/cs_configuration/chapter_overview.html) for instructions on setting up and starting the cluster for a client/server configuration. +see [Configuring and Running a Cluster](<%=vars.serverman%>/configuring/chapter_overview.html) +and [Client/Server Configuration](<%=vars.serverman%>/topologies_and_comm/cs_configuration/chapter_overview.html) for instructions on setting up and starting the cluster for a client/server configuration. ### <a id="connecting_to_server"></a>Connecting to the Server @@ -86,7 +86,7 @@ auto regionFactory = cache.createRegionFactory(RegionShortcut::PROXY); auto region = regionFactory.setPoolName("pool").create("exampleRegion"); ``` -See the _<%=vars.product_name%> User Guide_ section [Configuring a Client/Server System](serverman/topologies_and_comm/cs_configuration/setting_up_a_client_server_system.html) +See the _<%=vars.product_name%> User Guide_ section [Configuring a Client/Server System](<%=vars.serverman%>/topologies_and_comm/cs_configuration/setting_up_a_client_server_system.html) for more details. ### <a id="app_dev_walkthroughs"></a>Application Development Walkthrough diff --git a/docs/geode-native-docs-cpp/regions/regions.html.md.erb b/docs/geode-native-docs-cpp/regions/regions.html.md.erb index c9e3e80..e957a81 100644 --- a/docs/geode-native-docs-cpp/regions/regions.html.md.erb +++ b/docs/geode-native-docs-cpp/regions/regions.html.md.erb @@ -25,7 +25,7 @@ against them. In order to connect to a <%=vars.product_name%> server, a client application must define a region that corresponds to a region on the server, at least in name. -See [Data Regions](geodeman/basic_config/data_regions/chapter_overview.html) in the *<%=vars.product_name%> User Guide* +See [Data Regions](<%=vars.serverman%>/basic_config/data_regions/chapter_overview.html) in the *<%=vars.product_name%> User Guide* for details regarding server regions, and [Region Attributes](region-attributes.html) in this guide for client region configuration parameters. diff --git a/docs/geode-native-docs-cpp/remote-queries.html.md.erb b/docs/geode-native-docs-cpp/remote-queries.html.md.erb index 4bb9947..7c2cb0c 100644 --- a/docs/geode-native-docs-cpp/remote-queries.html.md.erb +++ b/docs/geode-native-docs-cpp/remote-queries.html.md.erb @@ -43,13 +43,13 @@ Nested data collections can be explicitly referenced in the FROM clause of a que A query execution returns its results as either a `ResultSet` or a `StructSet`. Query language features and grammar are described in the <%=vars.product_name%> manual at -[Querying](geodeman/developing/querying_basics/chapter_overview.html). +[Querying](<%=vars.serverman%>/developing/querying_basics/chapter_overview.html). ### <a id="CreatingIndexes"></a>Creating Indexes Indexes can provide significant performance gains for query execution. You create and maintain indexes on the cache server. For detailed information about working with indexes configured on a cache server, -see [Working with Indexes](geodeman/developing/query_index/query_index.html) in the server's documentation. +see [Working with Indexes](<%=vars.serverman%>/developing/query_index/query_index.html) in the server's documentation. ## <a id="RemoteQueryAPI"></a>Remote Query API diff --git a/docs/geode-native-docs-cpp/security/authentication.html.md.erb b/docs/geode-native-docs-cpp/security/authentication.html.md.erb index 6e19aa6..19063e5 100644 --- a/docs/geode-native-docs-cpp/security/authentication.html.md.erb +++ b/docs/geode-native-docs-cpp/security/authentication.html.md.erb @@ -20,7 +20,7 @@ limitations under the License. --> A client is authenticated when it connects with valid credentials to a <%=vars.product_name%> cache server that is configured with the client authentication callback. -For details on the server's role in authentication and what it expects from the client, see [Implementing Authentication](geodeman/managing/security/implementing_authentication.html) in the *<%=vars.product_name%> User Guide*. +For details on the server's role in authentication and what it expects from the client, see [Implementing Authentication](<%=vars.serverman%>/managing/security/implementing_authentication.html) in the *<%=vars.product_name%> User Guide*. In your application, authentication credentials must be set when creating the cache. In practice, this means setting the authentication credentials when you create the CacheFactory. diff --git a/docs/geode-native-docs-cpp/security/security.html.md.erb b/docs/geode-native-docs-cpp/security/security.html.md.erb index 516eaaf..43dd4d0 100644 --- a/docs/geode-native-docs-cpp/security/security.html.md.erb +++ b/docs/geode-native-docs-cpp/security/security.html.md.erb @@ -24,7 +24,7 @@ framework authenticates clients as they connect to a cache server and authorizes operations using developer-provided implementations for authentication and authorization. For an explanation of the server-side implementation of security features, -see [Security](geodeman/managing/security/chapter_overview.html) in the *<%=vars.product_name%> User Guide*. +see [Security](<%=vars.serverman%>/managing/security/chapter_overview.html) in the *<%=vars.product_name%> User Guide*. A Native Client application must address two security concerns when connecting to a <%=vars.product_name%> server: diff --git a/docs/geode-native-docs-cpp/security/sslclientserver.html.md.erb b/docs/geode-native-docs-cpp/security/sslclientserver.html.md.erb index 6cb5a12..5d6f07d 100644 --- a/docs/geode-native-docs-cpp/security/sslclientserver.html.md.erb +++ b/docs/geode-native-docs-cpp/security/sslclientserver.html.md.erb @@ -20,7 +20,7 @@ limitations under the License. --> This section describes how to implement TLS-based communication between your clients and servers using the OpenSSL encryption utility. -When configuring TLS/SSL security for your client, you may find it helpful to refer to [The SSL section of the <%=vars.product_name%> User Guide](serverman/managing/security/ssl_overview.html). +When configuring TLS/SSL security for your client, you may find it helpful to refer to [The SSL section of the <%=vars.product_name%> User Guide](<%=vars.serverman%>/managing/security/ssl_overview.html). # Set Up OpenSSL @@ -66,7 +66,7 @@ Specifically, ensure that: - You have generated the keys and keystores. - You have set the system properties. -For details on stopping and starting locators and cache servers with SSL, see [Starting Up and Shutting Down Your System](geodeman/configuring/running/starting_up_shutting_down.html). +For details on stopping and starting locators and cache servers with SSL, see [Starting Up and Shutting Down Your System](<%=vars.serverman%>/configuring/running/starting_up_shutting_down.html). **Example locator start command** diff --git a/docs/geode-native-docs-cpp/serialization/data-serialization.html.md.erb b/docs/geode-native-docs-cpp/serialization/data-serialization.html.md.erb index a99a879..6567315 100644 --- a/docs/geode-native-docs-cpp/serialization/data-serialization.html.md.erb +++ b/docs/geode-native-docs-cpp/serialization/data-serialization.html.md.erb @@ -26,5 +26,5 @@ between processes, of which [**<%=vars.product_name%> Portable Data eXchange (PD offers the best combination of versatility and ease-of-use for most applications. To learn more about other serialization options, see the [Data Serialization section in the -_<%=vars.product_name_long%> User Guide_](serverman/developing/data_serialization/chapter_overview.html). +_<%=vars.product_name_long%> User Guide_](<%=vars.serverman%>/developing/data_serialization/chapter_overview.html). diff --git a/docs/geode-native-docs-cpp/transactions.html.md.erb b/docs/geode-native-docs-cpp/transactions.html.md.erb index 94e8c52..af896c7 100644 --- a/docs/geode-native-docs-cpp/transactions.html.md.erb +++ b/docs/geode-native-docs-cpp/transactions.html.md.erb @@ -22,7 +22,7 @@ limitations under the License. The Native Client API runs transactions on the server as if they were local to the client application. Thus, the key to running client transactions lies in making sure the server is properly configured and programmed. For complete information about how transactions are conducted on the <%=vars.product_name%> server, see the -[Transactions section of the <%=vars.product_name%> User Guide](geodeman/developing/transactions/chapter_overview.html). +[Transactions section of the <%=vars.product_name%> User Guide](<%=vars.serverman%>/developing/transactions/chapter_overview.html). ## <a id="client-transaction-apis"></a>Native Client Transaction APIs diff --git a/docs/geode-native-docs-dotnet/about-client-users-guide.html.md.erb b/docs/geode-native-docs-dotnet/about-client-users-guide.html.md.erb index 3e33c1c..b7876ab 100644 --- a/docs/geode-native-docs-dotnet/about-client-users-guide.html.md.erb +++ b/docs/geode-native-docs-dotnet/about-client-users-guide.html.md.erb @@ -28,5 +28,5 @@ See the API docs for API details: - [C++ API docs](/<%=vars.cppapiref_version%>/hierarchy.html) - [.NET API docs](/<%=vars.dotnetapiref_version%>/hierarchy.html) -See the [_<%=vars.product_name_long%> User Guide_](serverman/about_<%=vars.product_name.downcase%>.html) for information regarding the server. +See the [_<%=vars.product_name_long%> User Guide_](<%=vars.serverman%>/about_<%=vars.product_name.downcase%>.html) for information regarding the server. diff --git a/docs/geode-native-docs-dotnet/configuring/config-client-cache.html.md.erb b/docs/geode-native-docs-dotnet/configuring/config-client-cache.html.md.erb index 1afa472..a07cb11 100644 --- a/docs/geode-native-docs-dotnet/configuring/config-client-cache.html.md.erb +++ b/docs/geode-native-docs-dotnet/configuring/config-client-cache.html.md.erb @@ -32,5 +32,5 @@ Regions are created from `Cache` instances. Regions provide the entry points to instances of `Region` and `RegionEntry`. For more information specific to your client programming language, see the -[.NET Client API](/dotnetapiref/hierarchy.html). +[.NET Client API](<%=vars.dotnetapiref%>/hierarchy.html). diff --git a/docs/geode-native-docs-dotnet/configuring/configuration.html.md.erb b/docs/geode-native-docs-dotnet/configuring/configuration.html.md.erb index 176cbea..a94927c 100644 --- a/docs/geode-native-docs-dotnet/configuring/configuration.html.md.erb +++ b/docs/geode-native-docs-dotnet/configuring/configuration.html.md.erb @@ -46,6 +46,6 @@ When redundancy is enabled, secondary servers maintain queue backups while the p events to the client. If the primary server fails, one of the secondary servers steps in as primary to provide uninterrupted event messaging to the client. To configure high availability, set the `subscription-redundancy` in the client’s pool configuration. This setting indicates the number of secondary servers to use. -See the _<%=vars.product_name%> User Guide_ section [Configuring Highly Available Servers](serverman/developing/events/configuring_highly_available_servers.html) +See the _<%=vars.product_name%> User Guide_ section [Configuring Highly Available Servers](<%=vars.serverman%>/developing/events/configuring_highly_available_servers.html) for more details. diff --git a/docs/geode-native-docs-dotnet/connection-pools/subscription-properties.html.md.erb b/docs/geode-native-docs-dotnet/connection-pools/subscription-properties.html.md.erb index 53f4fbc..e670f95 100644 --- a/docs/geode-native-docs-dotnet/connection-pools/subscription-properties.html.md.erb +++ b/docs/geode-native-docs-dotnet/connection-pools/subscription-properties.html.md.erb @@ -23,7 +23,7 @@ Each connection pool has a single subscription connection that can be to any ser When a client registers interest for a region, if the connection pool does not already have a subscription channel, the connection pool sends a message to the server locator, and the server locator chooses servers to host the queue and return those server names to the client. The client then contacts the chosen servers and asks them to create the queue. -The client maintains at least one connection with each server hosting a queue. If the server does not detect any connections from a non-durable client, it drops the client queue and closes all artifacts for the client. For information about durable client subscriptions, see [Implementing Durable Client/Server Messaging](/serverman/developing/events/implementing_durable_client_server_messaging.html). +The client maintains at least one connection with each server hosting a queue. If the server does not detect any connections from a non-durable client, it drops the client queue and closes all artifacts for the client. For information about durable client subscriptions, see [Implementing Durable Client/Server Messaging](<%=vars.serverman%>/developing/events/implementing_durable_client_server_messaging.html). ## <a id="subscription-properties__section_294BD33FBDC6454FAD9C5118829EBBA4" class="no-quick-link"></a>Requesting a Subscription Region Queue diff --git a/docs/geode-native-docs-dotnet/continuous-queries.html.md.erb b/docs/geode-native-docs-dotnet/continuous-queries.html.md.erb index 51bf966..f7f1afc 100644 --- a/docs/geode-native-docs-dotnet/continuous-queries.html.md.erb +++ b/docs/geode-native-docs-dotnet/continuous-queries.html.md.erb @@ -21,7 +21,7 @@ limitations under the License. The C++ and .NET clients can initiate queries that run on the <%=vars.product_name%> cache server and notify the client when the query results have changed. For details on the server-side setup for -continuous queries, see [How Continuous Querying Works](serverman/developing/continuous_querying/how_continuous_querying_works.html) +continuous queries, see [How Continuous Querying Works](<%=vars.serverman%>/developing/continuous_querying/how_continuous_querying_works.html) in the *<%=vars.product_name%> User Guide*. ## <a id="cq_main_features" ></a>Continuous Query Basics @@ -37,8 +37,8 @@ to process CQ events is based on the standard <%=vars.product_name%> event handl server-to-client messaging mechanisms to send events. All tuning of your server-to-client messaging also tunes the messaging of your CQ events. If your system is configured for high availability then your CQs are highly available, with seamless failover provided in case of -server failure (see [Highly Available Client/Server Event Messaging](/serverman/developing/events/ha_event_messaging_whats_next.html)). -If your clients are durable, you can also define any of your CQs as durable (see [Implementing Durable Client/Server Messaging](/serverman/developing/events/implementing_durable_client_server_messaging.html)). +server failure (see [Highly Available Client/Server Event Messaging](<%=vars.serverman%>/developing/events/ha_event_messaging_whats_next.html)). +If your clients are durable, you can also define any of your CQs as durable (see [Implementing Durable Client/Server Messaging](<%=vars.serverman%>/developing/events/implementing_durable_client_server_messaging.html)). - **Interest criteria based on data values**. Continuous queries are run against the region's entry values. Compare this to register interest by reviewing [Registering Interest for Entries](regions/registering-interest-for-entries.html). diff --git a/docs/geode-native-docs-dotnet/function-execution.html.md.erb b/docs/geode-native-docs-dotnet/function-execution.html.md.erb index 126530b..8c40e9f 100644 --- a/docs/geode-native-docs-dotnet/function-execution.html.md.erb +++ b/docs/geode-native-docs-dotnet/function-execution.html.md.erb @@ -28,7 +28,7 @@ To be callable from your client, a function must be - resident on the server, and - registered as available for client access. -See [Executing a Function in <%=vars.product_name_long%>](serverman/developing/function_exec/function_execution.html) +See [Executing a Function in <%=vars.product_name_long%>](<%=vars.serverman%>/developing/function_exec/function_execution.html) in the <%=vars.product_name%> User Guide for details on how to write and register server-resident functions. ## <a id="nc-fe-client_side_requirements"></a>Client-side Requirements diff --git a/docs/geode-native-docs-dotnet/getting-started/getting-started-nc-client.html.md.erb b/docs/geode-native-docs-dotnet/getting-started/getting-started-nc-client.html.md.erb index 37e9aff..a322e00 100644 --- a/docs/geode-native-docs-dotnet/getting-started/getting-started-nc-client.html.md.erb +++ b/docs/geode-native-docs-dotnet/getting-started/getting-started-nc-client.html.md.erb @@ -44,8 +44,8 @@ You can choose whether to use a large, remote, production-quality cluster; a sma 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) -and [Client/Server Configuration](serverman/topologies_and_comm/cs_configuration/chapter_overview.html) for instructions on setting up and starting the cluster for a client/server configuration. +see [Configuring and Running a Cluster](<%=vars.serverman%>/configuring/chapter_overview.html) +and [Client/Server Configuration](<%=vars.serverman%>/topologies_and_comm/cs_configuration/chapter_overview.html) for instructions on setting up and starting the cluster for a client/server configuration. ### <a id="connecting_to_server"></a>Connecting to the Server @@ -85,7 +85,7 @@ var regionFactory = cache.CreateRegionFactory(RegionShortcut.PROXY) var region = regionFactory.Create<string, string>("example_userinfo"); ``` -See the _<%=vars.product_name%> User Guide_ section [Configuring a Client/Server System](serverman/topologies_and_comm/cs_configuration/setting_up_a_client_server_system.html) +See the _<%=vars.product_name%> User Guide_ section [Configuring a Client/Server System](<%=vars.serverman%>/topologies_and_comm/cs_configuration/setting_up_a_client_server_system.html) for more details. diff --git a/docs/geode-native-docs-dotnet/preserving-data/configuring-durable-nc.html.md.erb b/docs/geode-native-docs-dotnet/preserving-data/configuring-durable-nc.html.md.erb index 3eb1a37..d866dad 100644 --- a/docs/geode-native-docs-dotnet/preserving-data/configuring-durable-nc.html.md.erb +++ b/docs/geode-native-docs-dotnet/preserving-data/configuring-durable-nc.html.md.erb @@ -29,7 +29,7 @@ The `durable-timeout` setting is a tuning parameter. When setting the timeout, t To assist with tuning, <%=vars.product_name%> statistics track message queues for durable clients through the disconnect and reconnect cycles. -When the queue is full, it blocks further operations that add messages until the queue size drops to an acceptable level. Server configuration sets the action to take. See details on server configuration of the queue in the server documentation section [Implementing Durable Client/Server Messaging](geodeman/developing/events/implementing_durable_client_server_messaging.html). +When the queue is full, it blocks further operations that add messages until the queue size drops to an acceptable level. Server configuration sets the action to take. See details on server configuration of the queue in the server documentation section [Implementing Durable Client/Server Messaging](<%=vars.serverman%>/developing/events/implementing_durable_client_server_messaging.html). ## Configuring a Durable Client Using geode.properties diff --git a/docs/geode-native-docs-dotnet/preserving-data/durable-client-messaging-req.html.md.erb b/docs/geode-native-docs-dotnet/preserving-data/durable-client-messaging-req.html.md.erb index a03e054..afd80c9 100644 --- a/docs/geode-native-docs-dotnet/preserving-data/durable-client-messaging-req.html.md.erb +++ b/docs/geode-native-docs-dotnet/preserving-data/durable-client-messaging-req.html.md.erb @@ -21,7 +21,7 @@ limitations under the License. The messaging queues used for durable messaging are the same regular messaging queues used for basic server-to-client messaging, with additional requirements. -See the server documentation at [Implementing Durable Client/Server Messaging](geodeman/developing/events/implementing_durable_client_server_messaging.html) for requirements, options, and functionality of messaging queues. If you are using highly available servers, see [High Availability for Client-Server Communication](high-availability-client-server.html#concept_F7A143F51EEA46B28AC612DEB7849D99) for additional requirements. +See the server documentation at [Implementing Durable Client/Server Messaging](<%=vars.serverman%>/developing/events/implementing_durable_client_server_messaging.html) for requirements, options, and functionality of messaging queues. If you are using highly available servers, see [High Availability for Client-Server Communication](high-availability-client-server.html#concept_F7A143F51EEA46B28AC612DEB7849D99) for additional requirements. For durable client messaging, you also need the following: diff --git a/docs/geode-native-docs-dotnet/preserving-data/high-availability-client-server.html.md.erb b/docs/geode-native-docs-dotnet/preserving-data/high-availability-client-server.html.md.erb index 4995022..cba09cb 100644 --- a/docs/geode-native-docs-dotnet/preserving-data/high-availability-client-server.html.md.erb +++ b/docs/geode-native-docs-dotnet/preserving-data/high-availability-client-server.html.md.erb @@ -21,7 +21,7 @@ limitations under the License. The client provides reliable event messaging from cache server to client to prevent data loss during server failover operations. High availability is implemented in the cache server and is configured in the client. -See server documentation at [Configuring Highly Available Servers](geodeman/developing/events/configuring_highly_available_servers.html) for details about configuring a server for high availability. +See server documentation at [Configuring Highly Available Servers](<%=vars.serverman%>/developing/events/configuring_highly_available_servers.html) for details about configuring a server for high availability. - **[Configuring Clients for High Availability](configuring-nc-ha.html)** diff --git a/docs/geode-native-docs-dotnet/preserving-data/impl-cache-listeners-durable-clients.html.md.erb b/docs/geode-native-docs-dotnet/preserving-data/impl-cache-listeners-durable-clients.html.md.erb index ae3b520..efe5c8e 100644 --- a/docs/geode-native-docs-dotnet/preserving-data/impl-cache-listeners-durable-clients.html.md.erb +++ b/docs/geode-native-docs-dotnet/preserving-data/impl-cache-listeners-durable-clients.html.md.erb @@ -27,7 +27,7 @@ For general instructions on implementing a cache listener, see [CacheListener](. Durable clients require special attention to cache callbacks generated by the cache listener. During the initialization window when a reconnecting client has a functioning cache but is still receiving the stored messages from the queue, the client can replay events that are long past. These events are not applied to the cache, but they are sent to the cache listener. If the listener’s callbacks invoked by these events make changes to the cache, that could conflict with current operations [...] -Consequently, you need to keep your callback implementations lightweight and not do anything in the cache that could produce incorrect results during this window. For details on implementing callbacks for <%=vars.product_name%> event handlers, see [Implementing Cache Event Handlers](geodeman/developing/events/implementing_cache_event_handlers.html). +Consequently, you need to keep your callback implementations lightweight and not do anything in the cache that could produce incorrect results during this window. For details on implementing callbacks for <%=vars.product_name%> event handlers, see [Implementing Cache Event Handlers](<%=vars.serverman%>/developing/events/implementing_cache_event_handlers.html). ## <a id="concept_3BD651087FC4470C8BAB6AFD97AEA689__section_F39E695D88E94D518F3E1778F37FAF11" class="no-quick-link"></a>Implementing the afterRegionLive Method diff --git a/docs/geode-native-docs-dotnet/preserving-data/using-queue-conflation.html.md.erb b/docs/geode-native-docs-dotnet/preserving-data/using-queue-conflation.html.md.erb index 9f45e52..90601bc 100644 --- a/docs/geode-native-docs-dotnet/preserving-data/using-queue-conflation.html.md.erb +++ b/docs/geode-native-docs-dotnet/preserving-data/using-queue-conflation.html.md.erb @@ -27,7 +27,7 @@ The queue managment code conflates entry updates as part of the enqueue operatio Only entry `update` messages in a cache server region with `distributed-no-ack` scope are conflated. Region operations and entry operations other than updates are not conflated. -For more information, see the server documentation at [Conflate the Server Subscription Queue](geodeman/developing/events/conflate_server_subscription_queue.html). +For more information, see the server documentation at [Conflate the Server Subscription Queue](<%=vars.serverman%>/developing/events/conflate_server_subscription_queue.html). ## <a id="concept_AEFA04AF9ABD42C0A37ED31806596D24__section_BE506A32A8E44073B197B03AC5232C01" class="no-quick-link"></a>Overriding Queue Conflation Per-Client diff --git a/docs/geode-native-docs-dotnet/regions/regions.html.md.erb b/docs/geode-native-docs-dotnet/regions/regions.html.md.erb index 2dd3f71..5ea0b8f 100644 --- a/docs/geode-native-docs-dotnet/regions/regions.html.md.erb +++ b/docs/geode-native-docs-dotnet/regions/regions.html.md.erb @@ -25,7 +25,7 @@ against them. In order to connect to a <%=vars.product_name%> server, a client application must define a region that corresponds to a region on the server, at least in name. -See [Data Regions](geodeman/basic_config/data_regions/chapter_overview.html) in the *<%=vars.product_name%> User Guide* +See [Data Regions](<%=vars.serverman%>/basic_config/data_regions/chapter_overview.html) in the *<%=vars.product_name%> User Guide* for details regarding server regions, and [Region Attributes](region-attributes.html) in this guide for client region configuration parameters. diff --git a/docs/geode-native-docs-dotnet/remote-queries.html.md.erb b/docs/geode-native-docs-dotnet/remote-queries.html.md.erb index 15e4f6b..a918d73 100644 --- a/docs/geode-native-docs-dotnet/remote-queries.html.md.erb +++ b/docs/geode-native-docs-dotnet/remote-queries.html.md.erb @@ -43,13 +43,13 @@ Nested data collections can be explicitly referenced in the FROM clause of a que A query execution returns its results as either a `ResultSet` or a `StructSet`. Query language features and grammar are described in the <%=vars.product_name%> manual at -[Querying](geodeman/developing/querying_basics/chapter_overview.html). +[Querying](<%=vars.serverman%>/developing/querying_basics/chapter_overview.html). ### <a id="CreatingIndexes"></a>Creating Indexes Indexes can provide significant performance gains for query execution. You create and maintain indexes on the cache server. For detailed information about working with indexes configured on a cache server, -see [Working with Indexes](geodeman/developing/query_index/query_index.html) in the server's documentation. +see [Working with Indexes](<%=vars.serverman%>/developing/query_index/query_index.html) in the server's documentation. ## <a id="RemoteQueryAPI"></a>Remote Query API diff --git a/docs/geode-native-docs-dotnet/security/authentication.html.md.erb b/docs/geode-native-docs-dotnet/security/authentication.html.md.erb index 4aa255e..77644e1 100644 --- a/docs/geode-native-docs-dotnet/security/authentication.html.md.erb +++ b/docs/geode-native-docs-dotnet/security/authentication.html.md.erb @@ -20,7 +20,7 @@ limitations under the License. --> A client is authenticated when it connects with valid credentials to a <%=vars.product_name%> cache server that is configured with the client authentication callback. -For details on the server's role in authentication and what it expects from the client, see [Implementing Authentication](geodeman/managing/security/implementing_authentication.html) in the *<%=vars.product_name%> User Guide*. +For details on the server's role in authentication and what it expects from the client, see [Implementing Authentication](<%=vars.serverman%>/managing/security/implementing_authentication.html) in the *<%=vars.product_name%> User Guide*. In your application, authentication credentials must be set when creating the cache. In practice, this means setting the authentication credentials when you create the CacheFactory. diff --git a/docs/geode-native-docs-dotnet/security/security.html.md.erb b/docs/geode-native-docs-dotnet/security/security.html.md.erb index 516eaaf..43dd4d0 100644 --- a/docs/geode-native-docs-dotnet/security/security.html.md.erb +++ b/docs/geode-native-docs-dotnet/security/security.html.md.erb @@ -24,7 +24,7 @@ framework authenticates clients as they connect to a cache server and authorizes operations using developer-provided implementations for authentication and authorization. For an explanation of the server-side implementation of security features, -see [Security](geodeman/managing/security/chapter_overview.html) in the *<%=vars.product_name%> User Guide*. +see [Security](<%=vars.serverman%>/managing/security/chapter_overview.html) in the *<%=vars.product_name%> User Guide*. A Native Client application must address two security concerns when connecting to a <%=vars.product_name%> server: diff --git a/docs/geode-native-docs-dotnet/security/sslclientserver.html.md.erb b/docs/geode-native-docs-dotnet/security/sslclientserver.html.md.erb index 6cb5a12..5d6f07d 100644 --- a/docs/geode-native-docs-dotnet/security/sslclientserver.html.md.erb +++ b/docs/geode-native-docs-dotnet/security/sslclientserver.html.md.erb @@ -20,7 +20,7 @@ limitations under the License. --> This section describes how to implement TLS-based communication between your clients and servers using the OpenSSL encryption utility. -When configuring TLS/SSL security for your client, you may find it helpful to refer to [The SSL section of the <%=vars.product_name%> User Guide](serverman/managing/security/ssl_overview.html). +When configuring TLS/SSL security for your client, you may find it helpful to refer to [The SSL section of the <%=vars.product_name%> User Guide](<%=vars.serverman%>/managing/security/ssl_overview.html). # Set Up OpenSSL @@ -66,7 +66,7 @@ Specifically, ensure that: - You have generated the keys and keystores. - You have set the system properties. -For details on stopping and starting locators and cache servers with SSL, see [Starting Up and Shutting Down Your System](geodeman/configuring/running/starting_up_shutting_down.html). +For details on stopping and starting locators and cache servers with SSL, see [Starting Up and Shutting Down Your System](<%=vars.serverman%>/configuring/running/starting_up_shutting_down.html). **Example locator start command** diff --git a/docs/geode-native-docs-dotnet/serialization/data-serialization.html.md.erb b/docs/geode-native-docs-dotnet/serialization/data-serialization.html.md.erb index 19330e6..cf9bdb1 100644 --- a/docs/geode-native-docs-dotnet/serialization/data-serialization.html.md.erb +++ b/docs/geode-native-docs-dotnet/serialization/data-serialization.html.md.erb @@ -32,4 +32,4 @@ Many .NET clients can take advantage of **PDX reflection-based autoserialization To learn more about other serialization options, see the [Data Serialization section in the _<%=vars.product_name_long%> User -Guide_](serverman/developing/data_serialization/chapter_overview.html). +Guide_](<%=vars.serverman%>/developing/data_serialization/chapter_overview.html). diff --git a/docs/geode-native-docs-dotnet/transactions.html.md.erb b/docs/geode-native-docs-dotnet/transactions.html.md.erb index fa6e080..f97feeb 100644 --- a/docs/geode-native-docs-dotnet/transactions.html.md.erb +++ b/docs/geode-native-docs-dotnet/transactions.html.md.erb @@ -22,7 +22,7 @@ limitations under the License. The Native Client API runs transactions on the server as if they were local to the client application. Thus, the key to running client transactions lies in making sure the server is properly configured and programmed. For complete information about how transactions are conducted on the <%=vars.product_name%> server, see the -[Transactions section of the <%=vars.product_name%> User Guide](geodeman/developing/transactions/chapter_overview.html). +[Transactions section of the <%=vars.product_name%> User Guide](<%=vars.serverman%>/developing/transactions/chapter_overview.html). ## <a id="client-transaction-apis"></a>Native Client Transaction APIs