Make release docs easier to find (#619)

devfile · Sep 17, 2021 · 873804b · 873804b
1 parent da05a3e
commit 873804b
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -28,6 +28,9 @@ The generated documentation of the Devfile 2.0 format, based on its json schema,
 
 Typescript model is build on each commit of main branch and available as NPM package at https://www.npmjs.com/package/@devfile/api
 
+## Release
+Release details and process are found in [Devfile Release](RELEASE.md)
+
 ## How to build
 
 In order to build the CRD and the various schemas, you don't need to install any pre-requisite apart from `docker`.

diff --git a/RELEASE.md b/RELEASE.md
@@ -0,0 +1,4 @@
+## Devfile Release
+
+Our current process is documented in 
+[Devfile Versioning and Release Process](docs/proposals/versioning-and-release.md).  
diff --git a/docs/proposals/versioning-and-release.md b/docs/proposals/versioning-and-release.md
@@ -1,7 +1,8 @@
 # Devfile Versioning and Release Process
-This design document outlines the proposed versioning and release process for the Devfile spec. 
+This document outlines the versioning and release process for the Devfile spec.
 
-This document summarizes parts from the Devfile API technical meeting slides presented by @davidfestal back in October, and I recommend having a read through of it: https://docs.google.com/presentation/d/1ohM1HzPB59a3ajvB7rVWJkKONLBAuT0mb5P20_A6vLs/edit#slide=id.g8fc722bef9_1_8
+##Reference  
+This process summarizes parts from the Devfile API technical meeting slides presented by @davidfestal back in October, and I recommend having a read through of it: https://docs.google.com/presentation/d/1ohM1HzPB59a3ajvB7rVWJkKONLBAuT0mb5P20_A6vLs/edit#slide=id.g8fc722bef9_1_8
 
 ## Versioning