Skip to content

Commit 85003fa

Browse files
committed
Issue #58: Added upgrade procedure documentation.
Signed-off-by: alexmerlin <[email protected]>
1 parent 03bc704 commit 85003fa

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

docs/book/v5/upgrading.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Upgrades
2+
3+
Dotkernel API does not provide an automatic upgrade path. Instead, the recommended procedure is to manually implement
4+
each modification listed in [releases](https://github.com/dotkernel/api/releases). Additionally, releases info can also
5+
be accessed as an [RSS](https://github.com/dotkernel/api/releases.atom) feed.
6+
7+
## Upgrade procedure
8+
9+
Once you clone Dotkernel API, you will find a CHANGELOG.md file in the root of the project. This contains a list of
10+
already implemented features in reversed chronological order. You can use this file to track the version your copy of
11+
Dotkernel API is at.
12+
13+
When there is a new release, you need to run through it and implement in your project the modifications from each pull
14+
request.
15+
16+
Finally, copy the release info and paste it at the beginning of your project's CHANGELOG.md file. This way you will be
17+
able to track your API's version info and keep your project up-to-date.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ nav:
2121
- "Doctrine ORM": v5/installation/doctrine-orm.md
2222
- "Test the Installation": v5/installation/test-the-installation.md
2323
- "FAQ": v5/installation/faq.md
24+
- Upgrading: v5/upgrading.md
2425
- Flow:
2526
- "Middleware Flow": v5/flow/middleware-flow.md
2627
- "Default Library Flow": v5/flow/default-library-flow.md

0 commit comments

Comments
 (0)