Merge pull request #59 from dotkernel/issue-58

Issue #58: Added upgrade procedure documentation.

Author: arhimede

docs/book/v5/upgrading.md

@@ -0,0 +1,18 @@
+# Upgrades
+
+Dotkernel API does not provide an automatic upgrade path.
+
+Instead, the recommended procedure is to manually implement each modification listed in [releases](https://github.com/dotkernel/api/releases).
+Additionally, releases info can also be accessed as an [RSS](https://github.com/dotkernel/api/releases.atom) feed.
+
+## Upgrade procedure
+
+Once you clone Dotkernel API, you will find a [CHANGELOG.md](https://github.com/dotkernel/api/blob/5.0/CHANGELOG.md) file in the root of the project.
+
+This contains a list of already implemented features in reversed chronological order.
+You can use this file to track the version your copy of Dotkernel API is at.
+
+When there is a new release, you need to run through it and implement in your project the modifications from each pull request.
+
+Finally, copy the release info and paste it at the beginning of your project's CHANGELOG.md file.
+This way you will be able to track your API's version info and keep your project up-to-date.

mkdocs.yml

@@ -21,6 +21,7 @@ nav:
           - "Doctrine ORM": v5/installation/doctrine-orm.md
           - "Test the Installation": v5/installation/test-the-installation.md
           - "FAQ": v5/installation/faq.md
+      - Upgrading: v5/upgrading.md
       - Flow:
           - "Middleware Flow": v5/flow/middleware-flow.md
           - "Default Library Flow": v5/flow/default-library-flow.md