[
https://issues.apache.org/jira/browse/GEODE-8122?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17108664#comment-17108664
]
ASF GitHub Bot commented on GEODE-8122:
---------------------------------------
sabbeyPivotal commented on a change in pull request #5122:
URL: https://github.com/apache/geode/pull/5122#discussion_r426047947
##########
File path: geode-docs/tools_modules/redis_api_for_geode.html.md.erb
##########
@@ -0,0 +1,87 @@
+<% set_title("Redis API for", product_name) %>
+
+<!--
+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 Redis API for <%=vars.product_name%> allows a single
<%=vars.product_name%> cluster to function as a drop-in replacement for a
+highly-available Redis data store with one database, letting Redis
applications take advantage of
+<%=vars.product_name%>’s scaling capabilities without changing their client
code. Redis clients connect to a <%=vars.product_name%>
+server in the same way they connect to a Redis server, using a hostname and a
port number, with
+optional password authentication.
+
+<img src="../images/redis_api_for_geode.png" class="image" />
+
+## <a id="using-the-redis-api-for-<%=vars.product_name_lowercase%>"
class="no-quick-link"></a>Using the Redis API for <%=vars.product_name%>
+
+The <%=vars.product_name%> cluster must have at least one server that is set
up to handle the incoming Redis
+commands.
+
+Use gfsh to start at least one server with a command of the form:
+
+``` pre
+start server --name=<serverName> --locators=<locatorPort>
--redis-port=<redisPort> --redis-bind-address=<redisBindAddress>
+```
+
+Replace `<serverName>` with the name of your server.
+
+Replace `<locatorPort>` with your locator port.
+
+Replace `<redisPort>` to specify the port the <%=vars.product_name%> server
will listen on for Redis commands (the typical default Redis port is 6379).
Review comment:
Thanks for the suggestion Karen. I just updated it!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> Update GeodeRedisServer java doc and Redis API for Geode documentation
> ----------------------------------------------------------------------
>
> Key: GEODE-8122
> URL: https://issues.apache.org/jira/browse/GEODE-8122
> Project: Geode
> Issue Type: Improvement
> Components: redis
> Reporter: Sarah Abbey
> Priority: Major
>
> - Java doc for GeodeRedisServer updated for current GA release plans
> - Java doc for ConfigurationProperties updated so it doesn't reference
> internal GeodeRedisServer
> - Geode docs for Redis API for Geode updated
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
