tonyair
/
silverstripe-versionfeed
mirror of https://github.com/silverstripe/silverstripe-versionfeed
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update documentation to include correct file paths

This commit is contained in:
Robbie Averill 2017-12-18 15:44:56 +13:00
parent dd361929db
commit 952b67a5cb
2 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -22,7 +22,7 @@ Install with composer by running `composer require silverstripe/versionfeed` in
For usage instructions see [user manual](docs/en/userguide/index.md).
### Translations
## Translations
Translations of the natural language strings are managed through a third party translation interface, transifex.com. Newly added strings will be periodically uploaded there for translation, and any new translations will be merged back to the project source code.

10
docs/en/developer.md
View File

@ -23,8 +23,10 @@ for the current page. You can override this behaviour by defining the `getDefaul
and returning the URL of your desired RSS feed:
```php
class MyPage extends Page {
function getDefaultRSSLink() {
class MyPage extends Page
{
public function getDefaultRSSLink()
{
return $this->Link('myrssfeed');
}
}
@ -34,7 +36,7 @@ This can be used in templates as `$DefaultRSSLink`.
### Rate limiting and caching
By default all content is filtered based on the rules specified in `versionfeed/_config/versionfeed.yml`.
By default all content is filtered based on the rules specified in `vendor/silverstripe/versionfeed/_config/versionfeed.yml`.
Two filters are applied on top of one another:
* `SilverStripe\VersionFeed\Filters\CachedContentFilter` provides caching of versions based on an identifier built up of the record ID and the
@ -64,4 +66,4 @@ will not trigger any rate limit safeguard, so you should be sure that this is se
You can set the `SilverStripe\VersionFeed\Filters\ContentFilter.cache_lifetime` config in order to control the maximum age of the cache.
This is an integer value in seconds, and defaults to 300 (five minutes). Set it to 0 or null to make this
cache unlimited.
cache unlimited.