| Summary: | ASTERISK-23764: Documentation - Enhance and fix documentation for Presence State in Asterisk | ||
| Reporter: | Rusty Newton (rnewton) | Labels: | |
| Date Opened: | 2014-05-20 13:41:25 | Date Closed: | 2014-05-21 17:54:22 |
| Priority: | Minor | Regression? | |
| Status: | Closed/Complete | Components: | Documentation |
| Versions: | Frequency of Occurrence | ||
| Related Issues: | |||
| Environment: | Attachments: | ||
| 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 help text for 'core show hints' i.e. 'core show help core show hints' only says 'List registered hints'. This could be improved to describe the columns included in the list. # 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. | ||
| Comments: | By: Rusty Newton (rnewton) 2014-05-20 13:44:11.615-0500 For number 1, I edited https://wiki.asterisk.org/wiki/display/AST/Presence+State for clarity, adding and removing quite a few things. Mostly formatting, the addition of example notification, clarification on hint definition. By: Rusty Newton (rnewton) 2014-05-20 13:58:01.801-0500 4 may be a bug.. in that it actually should work with that definition. talking with Mark Michelson If it is a bug, I need to re-correct my note on that definition in the wiki page. By: Rusty Newton (rnewton) 2014-05-21 17:55:30.101-0500 4 is not a bug. It is valid. 2 and 3 will be handled as part of another issue that already exists. By: Rusty Newton (rnewton) 2014-06-11 15:10:54.942-0500 Turned out I'm doing item 3 in https://reviewboard.asterisk.org/r/3610/ | ||