Emily Yeh created GEODE-3122:
--------------------------------
Summary: Update group(s)/member(s)/jar(s) and correct command
mistakes in docs
Key: GEODE-3122
URL: https://issues.apache.org/jira/browse/GEODE-3122
Project: Geode
Issue Type: Bug
Components: docs
Reporter: Emily Yeh
Since the implementation of
[GEODE-2818|https://issues.apache.org/jira/browse/GEODE-2818], it has become
possible for users to use the plural forms of certain parameters for certain
commands. {{group}} and {{groups}} are interchangeable for some commands, as
well as {{member}} and {{members}} and {{jar}} and {{jars}}. As a result, it
might be a good idea to include these aliases in the docs, as some commands
seem to imply that only singular values are accepted, when actually,
comma-separated lists are also acceptable.
Below is a list of commands that I found included these aliases, as well as any
typos I found.
{{alter runtime}}: {{group}} under Syntax can be changed to
{{\[\--group=value(,value)\*\]}} and {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{start locator}}: {{group}} under Syntax can be changed to
{{\[\--group=value(,value)\*\]}}
{{start server}}: {{group}} under Syntax can be changed to
{{\[\--group=value(,value)\*\]}}
{{export config}}: It might be a good idea to mention that users can only
specify members OR groups, not both at the same time
{{deploy}}: {{jar}} under Syntax can be changed to
{{\[\--jar=value(,value)\*\]}} and description of this command can be changed
to {{Paths of the JARs to deploy.}}
{{undeploy}}: {{jar}} under Syntax can be changed to
{{\[\--jar=value(,value)\*\]}} and the Syntax could probably be changed to
{{undeploy \[\--jar=value(,values)\*\] \[\--group=value(,values)\*\]}}
For {{deploy}} and {{undeploy}}, mention that user MUST specify either of
{{jar}} or {{dir}} options
{{list durable-cqs}}: {{group}} under Syntax can be changed to
{{\[\--group=value(,value)\*\]}} and {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{show subscription-queue-size}}: {{group}} under Syntax can be changed to
{{\[\--group=value(,value)\*\]}} and {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{close durable-cq}}: {{group}} under Syntax can be changed to
{{\[\--group=value(,value)\*\]}} and {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{close durable-client}}: {{group}} under Syntax can be changed to
{{\[\--group=value(,value)\*\]}} and {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{export logs}}: {{member}} under Syntax can be changed to
{{\[\--member=value(,value)\*\]}}
{{execute function}}: {{group}} under Syntax can be changed to
{{\[\--group=value(,value)\*\]}} (also, Syntax uses {{groups}} instead of
{{group}}, which is valid, but inconsistent)
{{destroy function}}: {{group}} under Syntax can be changed to
{{\[\--group=value(,value)\*\]}} (also, Syntax uses {{groups}} instead of
{{group}}, which is valid, but inconsistent)
{{create index}}: {{group}} under Syntax can be changed to
{{\[\--group=value(,value)\*\]}} and {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{destroy index}}: {{group}} under Syntax can be changed to
{{\[\--group=value(,value)\*\]}} and {{member}} can be changed to
{{\[\--member=value(,value)\*\]}} AND the docs say {{\--member: Id of the
member on which index is to be created.}} when it should say {{to be destroyed}}
{{create defined indexes}}: {{group}} under Syntax can be changed to
{{\[\--group=value(,value)\*\]}} and {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{export stack-traces}}: {{group}} under Syntax can be changed to
{{\[\--group=value(,value)\*\]}} and {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{change loglevel}}: OK but uses {{members}} and {{groups}} instead of standard
{{member}} and {{group}} (and not sure why optional additional arguments are
referred to as {{nullvalue}}?)
{{create async-event-queue}}: OK but uses {{groups}} instead of standard
{{group}} (and again, not sure why optional additional parameter values are
referred to as {{nullvalue}})
{{list regions}}: {{group}} under Syntax can be changed to
{{\[\--group=value(,value)\*\]}} and {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{create gateway-sender}}: OK but descriptions seem to be strictly singular
{{start gateway-sender}}: {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{pause gateway-sender}}: {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{resume gateway-sender}}: {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{stop gateway-sender}}: {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{create gateway-receiver}}: OK but descriptions seem to imply no plurals and
{{gateway}} is misspelled in the Example Command, {{create gatweway-receiver}}
{{start gateway-receiver}}: {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{stop gateway-receiver}}: {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{list gateways}}: {{member}} is not in the Syntax, so maybe add
{{\[\--member=value(,value)\*\]}}
{{status gateway-sender}}: {{member}} can be changed to
{{\[\--member=value(,value)\*\]}} AND the Example Command incorrectly refers to
{{status gateway-receiver}} (it also is missing the required {{\--id}}
parameter for {{status gateway-sender}})
{{status gateway-receiver}}: {{member}} can be changed to
{{\[\--member=value(,value)\*\]}}
{{destroy gateway-sender}}: not in the docs! (A ticket was already filed for
this)
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
