Add release note and docs for v1.4.0 (#151)

microsoft · Dec 2, 2020 · d48c658 · d48c658
1 parent ebd597d
commit d48c658
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 4 deletions.
diff --git a/RELEASE_NOTE.md b/RELEASE_NOTE.md
@@ -1,5 +1,14 @@
 # Openpaimarketplace Release Note
 
+## Dec 2020 (version 1.4.0)
+
+- Keep the release version aligned with [pai](https://github.com/microsoft/pai) (both with version v1.4.0).
+
+- Make the name of example templates human readable in Marketplace Webportal UI.
+  - Change names of /examples/examples.js human readable.
+  - Make the title of /examples/item_descriptions aligned with name of /examples/examples.js.
+  - Keep the name of /examples/item_protoocls illegal for OpenPAI. (Because the protocol will be submitted to OpenPAI cluster).
+
 ## Dec 2020 (version 1.3.0)
 
 - Better data storage experience

diff --git a/docs/admin/README.md b/docs/admin/README.md
@@ -1,6 +1,8 @@
 # OpenPAI Marketplace Doc for Admins
 
-In version 1.3.0, OpenPAI Marketplace can be deployed as services in OpenPAI cluster.
+> Note: This document suits for openpaimarketplace version v1.4.0 and later, and pai v1.4.0 and later.
+
+In version 1.4.0 and later, OpenPAI Marketplace can be deployed as services in OpenPAI cluster.
 Admin can choose to deploy the marketplace in PAI cluster [Deploy in OpenPAI cluster](./deployment.md#Deploy-in-PAI-cluster), or outside the cluster [Deploy without OpenPAI](./deployment.md#Deploy-without-OpenPAI).
 
 ## Table of Contents

diff --git a/docs/admin/deployment.md b/docs/admin/deployment.md
@@ -1,6 +1,8 @@
 # Deployment
 
-Currently (in version 1.3.0), you need to prepare three parts when deploying Marketplace: database, rest server and webportal.
+> Note: This deployment document suits for openpaimarketplace version v1.4.0 and later, and pai version v1.4.0 and later.
+
+To deploy OpenPAI Marketplace, you need to prepare three parts when deploying Marketplace: database, rest server and webportal.
 
 ## Deploy in OpenPAI cluster
 

diff --git a/docs/user/README.md b/docs/user/README.md
@@ -1,6 +1,8 @@
 # OpenPAI Marketplace Doc for Users
 
-Currently (in version 1.3.0), openpaimarketplace has two type of templates: data template and job tempalte. Both these two type of tempaltes could be directly used to create an OpenPAI job easily. The step-by-step usage guide is included in [quick start tutorial](./quick-start.md).
+> Note: This document suits for openpaimarketplace version v1.4.0 and later.
+
+Openpaimarketplace has two type of templates: data template and job tempalte. Both these two type of tempaltes could be directly used to create an OpenPAI job easily. The step-by-step usage guide is included in [quick start tutorial](./quick-start.md).
 
 - Data Template
 

diff --git a/docs/user/create_template.md b/docs/user/create_template.md
@@ -1,6 +1,6 @@
 # Create Template
 
-At current version (v1.3.0), the marketplace only support create job template. Create job template has 4 steps:
+At current version (v1.4.0), the marketplace only support create job template. Create job template has 4 steps:
 
 1. Click `Create` button at top right corner.
 2. Upload OpenPAI protocol yaml file.