[GitHub] [geode] ezoerner commented on a change in pull request #7326: GEODE-9999: Update the Geode for Redis documentation

[GitBox <gi...@apache.org>]

ezoerner commented on a change in pull request #7326:
URL: https://github.com/apache/geode/pull/7326#discussion_r794770935



##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -17,25 +17,22 @@ limitations under the License.
 
 <% set_title(product_name, "for Redis") %>
 
-<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as a drop-in replacement for a
+<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as a
 highly-available Redis data store, 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.
+<%=vars.product_name%>’s scaling capabilities with minimal changes to their client code.
 
-<img src="../images_svg/geode_for_redis.svg" class="image" />
 
 ## <a id="using-geode-for-redis"></a>Using <%=vars.product_name%> for Redis
+To use the <%=vars.product_name%> for Redis feature, the cluster must have at least one server that has enabled the feature to handle incoming Redis commands.
 
-The <%=vars.product_name%> cluster must have at least one server that is set up to handle the incoming Redis commands.
-
-Prerequisites for running the examples:
+Prerequisites:

Review comment:
       I had written "Prerequisites for running the examples" instead of just "Prerequisites" because installing the Redis CLI isn't really a prerequisite for running the product, is it?

##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -17,25 +17,22 @@ limitations under the License.
 
 <% set_title(product_name, "for Redis") %>
 
-<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as a drop-in replacement for a
+<%=vars.product_name%> for Redis allows <%=vars.product_name%> to function as a
 highly-available Redis data store, 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.
+<%=vars.product_name%>’s scaling capabilities with minimal changes to their client code.
 
-<img src="../images_svg/geode_for_redis.svg" class="image" />
 
 ## <a id="using-geode-for-redis"></a>Using <%=vars.product_name%> for Redis
+To use the <%=vars.product_name%> for Redis feature, the cluster must have at least one server that has enabled the feature to handle incoming Redis commands.
 
-The <%=vars.product_name%> cluster must have at least one server that is set up to handle the incoming Redis commands.
-
-Prerequisites for running the examples:
+Prerequisites:

Review comment:
       The Redis CLI should be mentioned as optional rather than a prerequisite

##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -229,27 +233,12 @@ integer (+/-&nbsp;9223372036854775807) for CURSOR.
 | server       | redis_version<br/>redis_mode (always returns "cluster" because <%=vars.product_name%> for Redis always runs in cluster mode.)<br/>tcp_port<br/>uptime_in_seconds<br/>uptime_in_days |
 | stats        | total_commands_processed<br/>instantaneous_ops_per_sec<br/>total_net_input_bytes<br/>instantaneous_input_kbps<br/>total_connections_received<br/>keyspace_hits<br/>keyspace_misses<br/>evicted_keys (always returns 0)<br/>rejected_connections (always returns 0)<br/>pubsub_channels<br/>pubsub_patterns|
 
-## <a id="advantages-over-redis"></a>Advantages of <%=vars.product_name%> over Redis

Review comment:
       Part of the original ticket was to add a section for advantages of using Geode for Redis, but if you don't think that it belongs here then ok

##########
File path: geode-docs/tools_modules/geode_for_redis.html.md.erb
##########
@@ -131,32 +113,35 @@ to implement redundant copies and this property corresponds to the partitioned r
 
 Security is implemented slightly differently to OSS Redis. Redis stores password information in plain text in the redis.conf file.
 
-When using <%=vars.product_name%>, to enable security, a Security Manager needs to be configured on the server(s).
-This Security Manager will authenticate `AUTH <password>` commands and `AUTH <username> <password>` commands.
-Users can set a custom `default` username using the `geode-for-redis-username` parameter.
-If users don't set this parameter, the default username  will be "default".
-This username will be used when `AUTH <password>` commands are sent without a `<username>`.
+When using <%=vars.product_name%>, to enable security, a Security Manager needs to be configured on the server(s) or _all_ `AUTH` requests will fail.
+
+This Security Manager will authenticate the `AUTH <password>` command and the `AUTH <username> <password>` command.
+Similar to OSS Redis, when users send the `AUTH <password>` command without a username, the system will use the default username `default`.

Review comment:
       Haven't we been calling it "native Redis", not "OSS Redis"? Technically Geode for Redis is also OSS Redis, isn't 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.

To unsubscribe, e-mail: notifications-unsubscribe@geode.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org