[asterisk-bugs] [JIRA] (ASTERISK-23764) Documentation - Enhance and fix documentation for Presence State in Asterisk

[Rusty Newton (JIRA)]

     [ https://issues.asterisk.org/jira/browse/ASTERISK-23764?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Rusty Newton updated ASTERISK-23764:
------------------------------------

    Description: 
In attempting to reproduce ASTERISK-23731 I refreshed myself on presence state and subscriptions.

I noticed that we could improve our documentation on the functionality. Notably the following:

 # The wiki page at https://wiki.asterisk.org/wiki/display/AST/Presence+State could be made more clear for a user in a number of ways.
 # The 'core show hints' command lists a "State", but it does not describe whether this is device state, extension state or presence state. I feel like this could be made more explicit, as the command will list a presence provider if referenced by a hint, but I don't think it is showing presence state.
 # The function help text for [PRESENCE_STATE|https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+Function_PRESENCE_STATE] shows an invalid hint definition.
{noformat}
exten => 1234,hint,,CustomPresence:lamp1
{noformat}
This will not allow the generation of notifications to the subscriber. A device must be associated to the hint as well for it to function.

  was:
In attempting to reproduce ASTERISK-23731 I refreshed myself on presence state and subscriptions.

I noticed that we could improve our documentation on the functionality. Notably the following:

 * The wiki page at https://wiki.asterisk.org/wiki/display/AST/Presence+State could be made more clear for a user in a number of ways.
 * The 'core show hints' command lists a "State", but it does not describe whether this is device state, extension state or presence state. I feel like this could be made more explicit, as the command will list a presence provider if referenced by a hint, but I don't think it is showing presence state.
 * The function help text for [PRESENCE_STATE|https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+Function_PRESENCE_STATE] shows an invalid hint definition.
{noformat}
exten => 1234,hint,,CustomPresence:lamp1
{noformat}
This will not allow the generation of notifications to the subscriber. A device must be associated to the hint as well for it to function.


> Documentation - Enhance and fix documentation for Presence State in Asterisk
> ----------------------------------------------------------------------------
>
>                 Key: ASTERISK-23764
>                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-23764
>             Project: Asterisk
>          Issue Type: Bug
>      Security Level: None
>          Components: Documentation
>            Reporter: Rusty Newton
>            Severity: Minor
>
> In attempting to reproduce ASTERISK-23731 I refreshed myself on presence state and subscriptions.
> I noticed that we could improve our documentation on the functionality. Notably the following:
>  # The wiki page at https://wiki.asterisk.org/wiki/display/AST/Presence+State could be made more clear for a user in a number of ways.
>  # The 'core show hints' command lists a "State", but it does not describe whether this is device state, extension state or presence state. I feel like this could be made more explicit, as the command will list a presence provider if referenced by a hint, but I don't think it is showing presence state.
>  # The function help text for [PRESENCE_STATE|https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+Function_PRESENCE_STATE] shows an invalid hint definition.
> {noformat}
> exten => 1234,hint,,CustomPresence:lamp1
> {noformat}
> This will not allow the generation of notifications to the subscriber. A device must be associated to the hint as well for it to function.



--
This message was sent by Atlassian JIRA
(v6.2#6252)