diff --git a/README.md b/README.md index 3e002dd..4bcde8b 100644 --- a/README.md +++ b/README.md @@ -16,11 +16,9 @@ Repository to describe, develop, document and test the Release Management proces ## Release Process Information -**The second public release of the Release Management documents with version v0.3.0 is availalbe in [r2.1](https://github.com/camaraproject/ReleaseManagement/releases/tag/r2.1)** +**The Release Management documents describes the processes and the repository provides the artifacts for use by API Sub projects to release an API version.** -It describes the processes and artifacts needed to release an API version. - -It contains the Release Management approved documents and assests in the **documentation** folder: +It contains the Release Management released documents and assests in the **documentation** folder: - [API_Release_Guidelines.md](/documentation/API_Release_Guidelines.md) - An extract of the API release management process from the CAMARA wiki. - [API-Readiness-Checklist.md](/documentation/API-Readiness-Checklist.md) - The checklist to ensure release readiness of the API according to its version (alpha, release-candidate, public). - [CHANGELOG_TEMPLATE.md](/documentation/CHANGELOG_TEMPLATE.md) - The template for creating CHANGELOG history of an API repository. @@ -30,6 +28,8 @@ It also contains the following in the **documentation/SupportingDocuments** fold For the reference documentation on API versioning, please see Chapter 5 in the API Design Guidelines document in [Commonalities](https://github.com/camaraproject/Commonalities). +The [CHANGELOG.md](/CHANGELOG.md) file describes the differences between releases of the Release Management repository. + ## Release Management Wiki Beyond the above reference release management information in GitHub, more information on the release process is available on the wiki.