tonyair/silverstripe-versionfeed
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-versionfeed synced 2024-10-22 11:05:31 +02:00
Code Issues Projects Releases Wiki Activity

Update documentation to include correct file paths

Browse Source
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). 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. 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.

8
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: and returning the URL of your desired RSS feed:
```php ```php
class MyPage extends Page { class MyPage extends Page
function getDefaultRSSLink() { {
public function getDefaultRSSLink()
{
return $this->Link('myrssfeed'); return $this->Link('myrssfeed');
} }
} }
@ -34,7 +36,7 @@ This can be used in templates as `$DefaultRSSLink`.
### Rate limiting and caching ### 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: 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 * `SilverStripe\VersionFeed\Filters\CachedContentFilter` provides caching of versions based on an identifier built up of the record ID and the