Subscriptions documentation

Subscriptions documentation

[Thomas.J.Waldmann, 2013-09-19 09:33:01]

https://codereview.appspot.com/13334053/diff/1/docs/user/subscriptions.rst
File docs/user/subscriptions.rst (right):

https://codereview.appspot.com/13334053/diff/1/docs/user/subscriptions.rst#ne...
docs/user/subscriptions.rst:29: * by tagname (`tags:<namespace>:<tag value>`),
it is the tag name from metadata
not "the tag" (that sounds like there could be only one tag in the item
metadata), but it triggers if one of the tags matched the given tag.

https://codereview.appspot.com/13334053/diff/1/docs/user/subscriptions.rst#ne...
docs/user/subscriptions.rst:32: * by a regular expression
(`namere:<namespace>:<name regexp>`)
in general you could maybe rather not tell "it is", but the condition when this
subscription matches/triggers.

https://codereview.appspot.com/13334053/diff/1/docs/user/subscriptions.rst#ne...
docs/user/subscriptions.rst:38: (`namere::.*`). Subscription by tagname can be
used for groups of items.
maybe these usage hints could be merged into the list above. if you feel it is
too much for list items, you could also use headings per subscription type.

https://codereview.appspot.com/13334053/diff/1/docs/user/subscriptions.rst#ne...
docs/user/subscriptions.rst:57: give a human-readable identifier to the
subscription.
"the name" - what if there are multiple?
is it "the current first name"?
maybe you should also tell that this is just for information and not used in any
way.

[Thomas.J.Waldmann, 2013-09-22 10:36:48]

https://codereview.appspot.com/13334053/diff/4001/docs/user/subscriptions.rst
File docs/user/subscriptions.rst (right):

https://codereview.appspot.com/13334053/diff/4001/docs/user/subscriptions.rst...
docs/user/subscriptions.rst:28: be subscribed using this type.
"which will be present even after renaming" is a bit misleading, all
subscriptions will be present after renaming, but the point is that if one
subscribes by itemid, it will still notify the subscriber after renaming / it is
resistent against renaming because the itemid never changes.

https://codereview.appspot.com/13334053/diff/4001/docs/user/subscriptions.rst...
docs/user/subscriptions.rst:31: The subscription will occur, if the name matches
any of the item names and also
you mean the notification, not the subscription.
but maybe rephrase this, sounds a bit strange.

https://codereview.appspot.com/13334053/diff/4001/docs/user/subscriptions.rst...
docs/user/subscriptions.rst:33: can be lost.
... would get lost if the new name doesn't match any more.

https://codereview.appspot.com/13334053/diff/4001/docs/user/subscriptions.rst...
docs/user/subscriptions.rst:42: item's namespace. For example if you want to
receive notifications about all
you are explaining prefix using the word prefix.
maybe rather say "name starts with the given prefix", so people that never heard
prefix can understand.

https://codereview.appspot.com/13334053/diff/4001/docs/user/subscriptions.rst...
docs/user/subscriptions.rst:44: use `nameprefix::foo`.
ok, here it is better.

https://codereview.appspot.com/13334053/diff/4001/docs/user/subscriptions.rst...
docs/user/subscriptions.rst:47: Used for subscription to a category of items.
The subscription will occur, if
be careful with the word category, categories were used in moin 1.9 in a similar
way as tags are used now, it might confuse people.

https://codereview.appspot.com/13334053/diff/4001/docs/user/subscriptions.rst...
docs/user/subscriptions.rst:50: namespace, then you can use `namere::.*`
hmm, ashutosh implemented "all" as pseudo-namespace meaning "namespace does not
matter". do you handle it in same way?

https://codereview.appspot.com/13334053/diff/4001/docs/user/subscriptions.rst...
docs/user/subscriptions.rst:68: The itemid subscriptions contain in parentheses
the current first name of the item
check grammar / word order

[Thomas.J.Waldmann, 2013-09-22 11:35:20]

https://codereview.appspot.com/13334053/diff/7001/docs/user/subscriptions.rst
File docs/user/subscriptions.rst (right):

https://codereview.appspot.com/13334053/diff/7001/docs/user/subscriptions.rst...
docs/user/subscriptions.rst:33: would be lost if the new name doesn't match any
more.
... and notifications for this item would stop working if the new name ...

https://codereview.appspot.com/13334053/diff/7001/docs/user/subscriptions.rst...
docs/user/subscriptions.rst:34: * by tagname (`tags:<namespace>:<tag value>`)
tagname or tag?

https://codereview.appspot.com/13334053/diff/7001/docs/user/subscriptions.rst...
docs/user/subscriptions.rst:37: metadata of the item and its namespace.
you didn't say "from the metadata of the item" when talking about name
subscription.
it's all in the meta, isn't it?

https://codereview.appspot.com/13334053/diff/7001/docs/user/subscriptions.rst...
docs/user/subscriptions.rst:41: one of the item names start with the given
prefix and matches item's namespace.
... one of the item names starts ... ("s" added)

https://codereview.appspot.com/13334053/diff/7001/docs/user/subscriptions.rst...
docs/user/subscriptions.rst:69: itself anyhow.
For itemid subscriptions, we additionally show the first item name in
parentheses (this is purely for your information and not stored or used in any
way).

[ana.balica, 2013-09-22 20:14:02]

https://codereview.appspot.com/13334053/diff/7001/docs/user/subscriptions.rst
File docs/user/subscriptions.rst (right):

https://codereview.appspot.com/13334053/diff/7001/docs/user/subscriptions.rst...
docs/user/subscriptions.rst:37: metadata of the item and its namespace.
On 2013/09/22 11:35:20, Thomas.J.Waldmann wrote:
> you didn't say "from the metadata of the item" when talking about name
> subscription.
> it's all in the meta, isn't it?

Yes, it's all from meta. I suppose if we leave it just tag, then it will clear
to users what kind of tag is that.

[ReimarBauer, 2013-09-23 06:47:52]

some notes

https://codereview.appspot.com/13334053/diff/11001/docs/user/subscriptions.rst
File docs/user/subscriptions.rst (right):

https://codereview.appspot.com/13334053/diff/11001/docs/user/subscriptions.rs...
docs/user/subscriptions.rst:5: Users can subscribe to moin pages or categories
in order to receive notifications
we don't have pages also don't have categories

https://codereview.appspot.com/13334053/diff/11001/docs/user/subscriptions.rs...
docs/user/subscriptions.rst:26: This is the most basic subscription to a single
item. The user will be notified
s/basic/common/  ?

https://codereview.appspot.com/13334053/diff/11001/docs/user/subscriptions.rs...
docs/user/subscriptions.rst:33: this item would stop working if the new name
doesn't match any more.
is the user getting some informations that he has subscriptions done which won't
match in the future.
How are those cleaned up

[ana.balica, 2013-09-23 08:39:39]

https://codereview.appspot.com/13334053/diff/11001/docs/user/subscriptions.rst
File docs/user/subscriptions.rst (right):

https://codereview.appspot.com/13334053/diff/11001/docs/user/subscriptions.rs...
docs/user/subscriptions.rst:33: this item would stop working if the new name
doesn't match any more.
On 2013/09/23 06:47:52, ReimarBauer wrote:
> is the user getting some informations that he has subscriptions done which
won't
> match in the future.
> How are those cleaned up

The subscription persist. If user was subscribed to an item via item name and it
was renamed, he will receive a notification about the rename. Subscription will
remain there and will be active (if say some other item with the old name is
created, then he will receive notifications of this new item).