Update readme.md and further links in rm project material

README.md

@@ -13,32 +13,36 @@ Repository to describe, develop, document and test the Release Management proces
 * Guidelines and assets for Release Management in CAMARA
 * Describe, develop, document and test the deliverables
 * Started: November 2023
+* First release: r1.0.0 (July 2024)
 
-## Release Information
+## Release Process Information
 
-This projects constains the following (documentation folder):
+This projects contains the following documentation:
 
-* API release guidelines
-* API readiness checklist 
+* [API Release Guidelines](/documentation/API_Release_Guidelines.md)
+* [API Readiness Checklist (template for copying)](/documentation/API-Readiness-Checklist.md)
+* [CHANGELOG (template for copying)](/documentation/CHANGELOG_TEMPLATE.md)
 
-More detailed information can be found in the below wiki pages.
+An example of the CHANGELOG created per the release management process is here: [CHANGELOG EXAMPLE](/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.md)
 
-Some quick-access links to content within the wiki:
+The reference documentation on API versioning is here: [Commonalities API design guidelines (section 5)](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md)
 
-* **Meta-Releases of CAMARA**
+## Release Management Wiki
 
-  * **[Meta-Release Fall24](https://wiki.camaraproject.org/x/cgB0AQ)**
-  * [Meta-release Milestones](https://wiki.camaraproject.org/x/16N3)
-  * [Meta-release Process](https://wiki.camaraproject.org/x/G7N3)
+Beyond the above reference release management information in GitHub, more information on the release process is available on the wiki.
+
+* **Meta-releases of CAMARA**
 
-* Processes for API Sub Projects
+  * [Meta-release Plans](https://wiki.camaraproject.org/x/2qN3)
+  * [Meta-release Process](https://wiki.camaraproject.org/x/G7N3)
 
+* **API release management**
   * [API Release Process](https://wiki.camaraproject.org/x/AgAVAQ)
-  * [API Readiness Checklist](https://wiki.camaraproject.org/display/CAM/API+Release+Process#APIReleaseProcess-APIreadinesschecklist)
-  * [API release tracking process](https://wiki.camaraproject.org/x/HQBFAQ)
-  * [API versioning](https://wiki.camaraproject.org/display/CAM/API+versioning)
+  * [API Release Tracking Process](https://wiki.camaraproject.org/x/HQBFAQ)
+  * [More on API Readiness Checklist](https://wiki.camaraproject.org/display/CAM/API+Release+Process#APIReleaseProcess-APIreadinesschecklist)
+  * [More on API Versioning](https://wiki.camaraproject.org/display/CAM/API+versioning)
 
-* Processes and release numbering for Commonalities and ICM
+More information about processes and release numbering for Commonalities and ICM can be found here:
 
   * [Commonalities and ICM Release Process](https://wiki.camaraproject.org/display/CAM/Meta-release+Process#MetareleaseProcess-CommonalitiesandICM)
 

documentation/API-Readiness-Checklist.md

@@ -24,4 +24,4 @@ To fill the checklist:
 
 Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
 
-The documentation for the content of the checklist is here: [API Readiness Checklist](https://wiki.camaraproject.org/x/HQBFAQ)
+The documentation for the content of the checklist is here: [API Readiness Checklist](https://wiki.camaraproject.org/display/CAM/API+Release+Process#APIReleaseProcess-APIreadinesschecklist).

documentation/API_Release_Guidelines.md

@@ -108,24 +108,24 @@ This section lists the steps to release an API version. More details can be foun
 
 On the main branch,
 * develop the API scope in a "work-in-progress mode" (API version = wip and version in URL is vwip).
-* make sure to create the required release assets and record them in the `API-Readiness-Checklist.md` file
+* make sure to create the required release assets and record them in the `APIname-API-Readiness-Checklist.md` file. If not yet available, copy the template [API-Readiness-Checklist.md](/documentation/API-Readiness-Checklist.md), and prefix it with the API name.
 
 **Create the release PR**
 
 Once the defined scope and required stability is reached, create the (pre-)release PR.
 
 A (pre-)release PR provides only the following changes: 
 * update of the version information in the API OAS definition files (no "wip" in the version field and base URL of any of the API files).
-* update the `API-Readiness-Checklist.md` file ensuring all required release assets are available. If this file not yet available, create a local copy under the /documentation folder and prefix it with the respective API name (copy it from [ReleaseManagement/documentation/API-Readiness-Checklist.md](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md).
-* update the `CHANGELOG.md` file in the home of the API repository. If not yet available, copy it from [ReleaseManagement/documentation/CHANGELOG_TEMPLATE.md](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/CHANGELOG_TEMPLATE.md). See also the example available there.
+* complete the `APIname-API-Readiness-Checklist.md` file ensuring all required release assets are available. If not yet available, copy the template [API-Readiness-Checklist.md](/documentation/API-Readiness-Checklist.md), and prefix it with the API name.
+* update the `CHANGELOG.md` file in the home of the API repository. If not yet available, copy the [CHANGELOG_TEMPLATE.md](/documentation/CHANGELOG_TEMPLATE.md). See also the example available in the [SupportingDocuments folder](/documentation/SupportingDocuments).
   * add a new section at the top of the file for the release and each API version with the following content:
     * for each first alpha or release-candidate API version, all changes since the release of the previous public API version
     * for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release
     * for a public API version, the consolidated changes since the release of the previous public API version
 * update of the API repository `README.md` file (as necessary)
 
 **Create the release**
-* manage the release PR approval
+* manage the release PR approval with the Release Management team
 * merge the approved release PR
 * create the release:
   * an API release is created using the GitHub release feature (a release tag and, optionally, a release package).