Skip to content

Commit 003c1bb

Browse files
committed
review modifications
Signed-off-by: alexmerlin <[email protected]>
1 parent 85003fa commit 003c1bb

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

docs/book/v5/upgrading.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
11
# Upgrades
22

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.
3+
Dotkernel API does not provide an automatic upgrade path.
4+
5+
Instead, the recommended procedure is to manually implement
6+
each modification listed in [releases](https://github.com/dotkernel/api/releases).
7+
8+
Additionally, releases info can also be accessed as an [RSS](https://github.com/dotkernel/api/releases.atom) feed.
69

710
## Upgrade procedure
811

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+
Once you clone Dotkernel API, you will find a [CHANGELOG.md](https://github.com/dotkernel/api/blob/5.0/CHANGELOG.md)
13+
file in the root of the project.
14+
15+
This contains a list of already implemented features in reversed chronological order.
16+
17+
You can use this file to track the version your copy of Dotkernel API is at.
1218

1319
When there is a new release, you need to run through it and implement in your project the modifications from each pull
1420
request.
1521

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.
22+
Finally, copy the release info and paste it at the beginning of your project's CHANGELOG.md file.
23+
24+
This way you will be able to track your API's version info and keep your project up-to-date.

0 commit comments

Comments
 (0)