geode-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Emily Yeh (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (GEODE-3122) Update group(s)/member(s)/jar(s) and correct command mistakes in docs
Date Fri, 23 Jun 2017 18:28:00 GMT

     [ https://issues.apache.org/jira/browse/GEODE-3122?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Emily Yeh updated GEODE-3122:
-----------------------------
    Description: 
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 [user docs|http://geode.apache.org/docs/guide/11/about_geode.html], as
some commands seem to imply that only singular values are accepted, when actually, comma-separated
lists are also acceptable.

In addition, for commands that do already specify that a list of values can be accepted AND
that allow for the plural form of a given parameter, it may be a good idea to format the syntax
as (for example) {{\[\--member(s)=value(,value)\*\]}}.

*Below is a list of commands that I found included these aliases, as well as any typos I found.*
*Note that after changing the syntax entries for some of these command parameters, it may
also be a good idea to change the descriptions to indicate that the plural forms of these
parameters can be used.*

----

{{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
XOR groups, not both at the same time

{{deploy}}: {{jar}} under Syntax can be changed to {{\[\--jar=value(,value)\*\]}} and the
description of this command can be changed to {{Paths of the JARs to deploy.}} And it might
be a good idea to mention that users must specify either of {{jar}} or {{dir}} options

{{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)\*\]}}
and again, it might be a good idea to mention that users 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 with
other commands)

{{destroy function}}: {{group}} under Syntax can be changed to {{\[\--group=value(,value)\*\]}}
(also, Syntax uses {{groups}} instead of {{group}}, which is valid, but inconsistent with
other commands)

{{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)\*\]}}
In addition, 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}}: This command uses {{members}} and {{groups}} instead of standard {{member}}
and {{group}} (and not sure why optional additional arguments are referred to as {{nullvalue}}
instead of the standard {{value}})

{{create async-event-queue}}: This command uses {{groups}} instead of standard {{group}} (and
again, not sure why optional additional parameter values are referred to as {{nullvalue}}
instead of the standard {{value}})

{{list regions}}: {{group}} under Syntax can be changed to {{\[\--group=value(,value)\*\]}}
and {{member}} can be changed to {{\[\--member=value(,value)\*\]}}

{{create gateway-sender}}: The descriptions of the command parameters seem to be strictly
singular, when they can also be plural

{{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}}: The descriptions of the command parameters seem to be strictly
singular, when they can also be plural, 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}}: This command is not in the docs at all - a ticket was filed for
this earlier: [GEODE-2991|https://issues.apache.org/jira/browse/GEODE-2991]

  was:
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 [user docs|http://geode.apache.org/docs/guide/11/about_geode.html], as
some commands seem to imply that only singular values are accepted, when actually, comma-separated
lists are also acceptable.

In addition, for commands that do already specify that a list of values can be accepted AND
that allow for the plural form of a given parameter, it may be a good idea to format the syntax
as (for example) {{\[\--member(s)=value(,value)\*\]}}.

*Below is a list of commands that I found included these aliases, as well as any typos I found.*
*Note that after changing the syntax entries for some of these command parameters, it may
also be a good idea to change the descriptions to indicate that the plural forms of these
parameters can be used.*

{{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
XOR groups, not both at the same time

{{deploy}}: {{jar}} under Syntax can be changed to {{\[\--jar=value(,value)\*\]}} and the
description of this command can be changed to {{Paths of the JARs to deploy.}} And it might
be a good idea to mention that users must specify either of {{jar}} or {{dir}} options

{{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)\*\]}}
and again, it might be a good idea to mention that users 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 with
other commands)

{{destroy function}}: {{group}} under Syntax can be changed to {{\[\--group=value(,value)\*\]}}
(also, Syntax uses {{groups}} instead of {{group}}, which is valid, but inconsistent with
other commands)

{{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)\*\]}}
In addition, 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}}: This command uses {{members}} and {{groups}} instead of standard {{member}}
and {{group}} (and not sure why optional additional arguments are referred to as {{nullvalue}}
instead of the standard {{value}})

{{create async-event-queue}}: This command uses {{groups}} instead of standard {{group}} (and
again, not sure why optional additional parameter values are referred to as {{nullvalue}}
instead of the standard {{value}})

{{list regions}}: {{group}} under Syntax can be changed to {{\[\--group=value(,value)\*\]}}
and {{member}} can be changed to {{\[\--member=value(,value)\*\]}}

{{create gateway-sender}}: The descriptions of the command parameters seem to be strictly
singular, when they can also be plural

{{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}}: The descriptions of the command parameters seem to be strictly
singular, when they can also be plural, 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}}: This command is not in the docs at all - a ticket was filed for
this earlier: [GEODE-2991|https://issues.apache.org/jira/browse/GEODE-2991]


> 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 [user docs|http://geode.apache.org/docs/guide/11/about_geode.html], as
some commands seem to imply that only singular values are accepted, when actually, comma-separated
lists are also acceptable.
> In addition, for commands that do already specify that a list of values can be accepted
AND that allow for the plural form of a given parameter, it may be a good idea to format the
syntax as (for example) {{\[\--member(s)=value(,value)\*\]}}.
> *Below is a list of commands that I found included these aliases, as well as any typos
I found.*
> *Note that after changing the syntax entries for some of these command parameters, it
may also be a good idea to change the descriptions to indicate that the plural forms of these
parameters can be used.*
> ----
> {{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
XOR groups, not both at the same time
> {{deploy}}: {{jar}} under Syntax can be changed to {{\[\--jar=value(,value)\*\]}} and
the description of this command can be changed to {{Paths of the JARs to deploy.}} And it
might be a good idea to mention that users must specify either of {{jar}} or {{dir}} options
> {{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)\*\]}}
and again, it might be a good idea to mention that users 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 with
other commands)
> {{destroy function}}: {{group}} under Syntax can be changed to {{\[\--group=value(,value)\*\]}}
(also, Syntax uses {{groups}} instead of {{group}}, which is valid, but inconsistent with
other commands)
> {{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)\*\]}}
> In addition, 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}}: This command uses {{members}} and {{groups}} instead of standard
{{member}} and {{group}} (and not sure why optional additional arguments are referred to as
{{nullvalue}} instead of the standard {{value}})
> {{create async-event-queue}}: This command uses {{groups}} instead of standard {{group}}
(and again, not sure why optional additional parameter values are referred to as {{nullvalue}}
instead of the standard {{value}})
> {{list regions}}: {{group}} under Syntax can be changed to {{\[\--group=value(,value)\*\]}}
and {{member}} can be changed to {{\[\--member=value(,value)\*\]}}
> {{create gateway-sender}}: The descriptions of the command parameters seem to be strictly
singular, when they can also be plural
> {{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}}: The descriptions of the command parameters seem to be strictly
singular, when they can also be plural, 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}}: This command is not in the docs at all - a ticket was filed
for this earlier: [GEODE-2991|https://issues.apache.org/jira/browse/GEODE-2991]



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Mime
View raw message