Adjust docs by nickvergessen · Pull Request #86 · nextcloud/activity

nickvergessen · 2016-12-12T13:05:34Z

Signed-off-by: Joas Schilling <coding@schilljs.com>

ChristophWurst

looks good, just some typos and nitpicks :-)

ChristophWurst · 2016-12-12T21:10:09Z

docs/create.md

+To create and publish an event to the activity app, a new `IEvent` should be fetched from the activity manager and afterwards be passed to the `publish()` method:
+
+```php
+$event = \OC::$server->getActivityManager()->createEvent();


we should also mention that IManager can be injected into classes, which is obviously preferred over querying the server directly. Expect people to copy sample code from the docs :-)

ChristophWurst · 2016-12-12T21:11:01Z

docs/create.md

+\OC::$server->getActivityManager()->publish($event);
+```
+
+Tthe following values **must** be set, before publishing an event:


"Tthe" ;-)

remove the comma

ChristophWurst · 2016-12-12T21:11:53Z

docs/create.md

+* `setType()`
+* `setAffectedUser()`
+* `setAuthor()`
+* `setTimestamp()`


I didn't set a timestamp in twofactor_totp and it still worked 🙈

Legacy https://github.com/nextcloud/server/blob/08ef7356f67ff0d6c306633d55cb63183296ed57/lib/private/Activity/Manager.php#L177-L185

ChristophWurst · 2016-12-12T21:18:56Z

docs/provider.md

+
+### Check responsibility
+
+The first thing the provider should do, is to check whether the `IEvent` is on it cares about. A simple check for the app and maybe additionally the type, if the app has more then one provider, should be enough:


ChristophWurst · 2016-12-12T21:20:24Z

docs/provider.md

+
+### Long translations with "rich object" string
+
+In the long version for the normal activity stream contains the filename. Objects like users , files and more can be highlighted in the "rich subject", which allows the app to show an avatar next to the name, link the file name to the file list, and many more things.


remove space before comma

remove comma before "and" at the end of the last sentence

ChristophWurst · 2016-12-12T21:21:51Z

docs/provider.md

+The `IEvent::setRichSubject()` method has two arguments:
+
+1. The already translated string with placeholders
+2. The list of placeholders, in the case of the favorite provider it's the file that was favorites


"was marked as favorit"?

ChristophWurst · 2016-12-12T21:24:55Z

docs/provider.md

+* Both events need to have the same subject `getSubject()`
+* Both events need to have the same object type `getObjectType()`
+* The time difference between both events must not be bigger then 3 hours
+* Only up to 5 events can be merged.


why do we have a limit of 5 events? Imagine I upload a series of photos, say a batch of 500. I don't want to see 100 activities.

Well the API queries 30 entries at once, so that is the highest limit. But then again, when you dont see thumbnails and file names but just a "and 100 more" it's of no use either. We can discuss this further in the future, but for now that is the limitation.

ChristophWurst · 2016-12-12T21:26:02Z

docs/setting.md

+
+## Name
+
+The name **must** already be translated and should bea short and descriptive sentence. One or two important words can also be highlighted using the `<strong>` HTML tag, to allow easier recognition of the setting.


"bea" -> "be a"

ChristophWurst · 2016-12-12T21:27:06Z

docs/setting.md

+
+## Is default enabled stream / mail
+
+The two "is default enabled x" booleans specify whether the setting is enabled or disabled by default for the stream or mail. Once a user changed their setting, the default is not used for them anymore. Changing the default is therefor not "retro active".


http://dict.leo.org/ende/index_de.html#/search=therefor&searchLoc=0&resultOrder=basic&multiwordShowSingle=on&pos=0 apparently both are fine, one is formal the other informal.

Signed-off-by: Joas Schilling <coding@schilljs.com>

ChristophWurst

Nice!

Adjust the v2 endpoint docs

cd8868c

Signed-off-by: Joas Schilling <coding@schilljs.com>

nickvergessen added 2. developing bug feature: api labels Dec 12, 2016

nickvergessen added this to the Nextcloud 11.0 milestone Dec 12, 2016

nickvergessen force-pushed the adjust-docs branch 2 times, most recently from 8198922 to 452671e Compare December 12, 2016 13:30

nickvergessen added 4 commits December 12, 2016 15:39

Add docs about filters

aad6d16

Signed-off-by: Joas Schilling <coding@schilljs.com>

Add docs about the new ISetting implementation

525d7fd

Signed-off-by: Joas Schilling <coding@schilljs.com>

Add docs for the provider

1798223

Signed-off-by: Joas Schilling <coding@schilljs.com>

Update README info

c7a8384

Signed-off-by: Joas Schilling <coding@schilljs.com>

nickvergessen force-pushed the adjust-docs branch from 452671e to c7a8384 Compare December 12, 2016 16:02

ChristophWurst self-assigned this Dec 12, 2016

Add docs how to create an event

2282b35

Signed-off-by: Joas Schilling <coding@schilljs.com>

ChristophWurst requested changes Dec 12, 2016

View reviewed changes

ChristophWurst removed their assignment Dec 12, 2016

Fix comments

54bec96

Signed-off-by: Joas Schilling <coding@schilljs.com>

ChristophWurst approved these changes Dec 13, 2016

View reviewed changes

ChristophWurst merged commit 58094a8 into master Dec 13, 2016

ChristophWurst deleted the adjust-docs branch December 13, 2016 13:56

nickvergessen mentioned this pull request Dec 14, 2016

[stable11] Update docs and samples #92

Merged


		### Check responsibility

		The first thing the provider should do, is to check whether the `IEvent` is on it cares about. A simple check for the app and maybe additionally the type, if the app has more then one provider, should be enough:


		### Long translations with "rich object" string

		In the long version for the normal activity stream contains the filename. Objects like users , files and more can be highlighted in the "rich subject", which allows the app to show an avatar next to the name, link the file name to the file list, and many more things.


		## Name

		The name must already be translated and should bea short and descriptive sentence. One or two important words can also be highlighted using the `<strong>` HTML tag, to allow easier recognition of the setting.


		## Is default enabled stream / mail

		The two "is default enabled x" booleans specify whether the setting is enabled or disabled by default for the stream or mail. Once a user changed their setting, the default is not used for them anymore. Changing the default is therefor not "retro active".

Conversation

nickvergessen commented Dec 12, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ChristophWurst left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ChristophWurst left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

nickvergessen commented Dec 12, 2016 •

edited

Loading