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

36 lines
1.3 KiB
Markdown
Raw Normal View History

improve docs - Document new features - Document upgrading
2015-05-26 00:52:35 +02:00
# SilverStripe Blog Module
Initial commit
2013-08-11 00:59:15 +02:00
UPDATE: change the links for readme badges
2015-06-05 02:41:40 +02:00
[![Build Status](https://travis-ci.org/silverstripe/silverstripe-blog.png?branch=master)](https://travis-ci.org/silverstripe/silverstripe-blog) [![Latest Stable Version](https://poser.pugx.org/silverstripe/blog/v/stable.svg)](https://packagist.org/packages/silverstripe/blog) [![Total Downloads](https://poser.pugx.org/silverstripe/blog/downloads.svg)](https://packagist.org/packages/silverstripe/blog) [![Latest Unstable Version](https://poser.pugx.org/silverstripe/blog/v/unstable.svg)](https://packagist.org/silverstripe/silverstripe/blog) [![License](https://poser.pugx.org/silverstripe/blog/license.svg)](https://packagist.org/packages/silverstripe/blog)
Updated README
2013-08-11 01:26:17 +02:00
DOCS Rework documentation to have clear user guide and dev docs.
2015-12-07 23:45:09 +01:00
## Documentation
[User guide](docs/en/userguide/index.md)
corrected readme
2013-08-11 02:58:25 +02:00
DOCS Rework documentation to have clear user guide and dev docs.
2015-12-07 23:45:09 +01:00
[Developer documentation](docs/en/index.md)
Updated composer and renamed from silverstripe-blog to silverstripe-blogger to avoid confusion
2013-08-11 02:33:53 +02:00
improve docs - Document new features - Document upgrading
2015-05-26 00:52:35 +02:00
## Requirements
```
silverstripe/cms: ~3.1
Update README to include additional requirements This adds the additional requirements listed in the `composer.json` file.
2015-10-16 17:24:29 +02:00
silverstripe/lumberjack: ~1.1
silverstripe/tagfield: ^1.0
improve docs - Document new features - Document upgrading
2015-05-26 00:52:35 +02:00
```
### Suggested Modules
```
silverstripe/widgets: *
silverstripe/comments: *
```
## Installation
```
composer require silverstripe/blog 2.0.x-dev
```
DOCS Updating information about BlogMigrationTask This no longer automatically runs during dev/build. Migration should be conscious decision to run when a developer decides to update and avoids the risk of accidentally migrating on a live site when perhaps this was not the intention. I mention the move from 1.0 to 2.0 as this is a safe migration that some version old versions. Likely the upgrade path would be best if (1) Upgrade you really old blog up to 1.0 (2) Update your codebase to 2.0 code (3) Run the migration task.
2015-06-28 02:01:19 +02:00
## Upgrading legacy blog to 2.0
improve docs - Document new features - Document upgrading
2015-05-26 00:52:35 +02:00
DOCS Updating information about BlogMigrationTask This no longer automatically runs during dev/build. Migration should be conscious decision to run when a developer decides to update and avoids the risk of accidentally migrating on a live site when perhaps this was not the intention. I mention the move from 1.0 to 2.0 as this is a safe migration that some version old versions. Likely the upgrade path would be best if (1) Upgrade you really old blog up to 1.0 (2) Update your codebase to 2.0 code (3) Run the migration task.
2015-06-28 02:01:19 +02:00
If you're upgrading from blog version 1.0 to 2.0 you will need to run the `BlogMigrationTask`. Run the task using `dev/tasks/BlogMigrationTask` either via the browser or sake CLI to migrate your legacy blog to the new version data structure.
improve docs - Document new features - Document upgrading
2015-05-26 00:52:35 +02:00