[systemds-website] branch master updated: [DOCS] Add release specific docs update instructions (#96)

[ja...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

janardhan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/systemds-website.git


The following commit(s) were added to refs/heads/master by this push:
     new c88c5d0  [DOCS] Add release specific docs update instructions (#96)
c88c5d0 is described below

commit c88c5d0fb0925db1e0117222429c58835bb94a4a
Author: Janardhan Pulivarthi <j1...@protonmail.com>
AuthorDate: Wed Jun 30 21:25:29 2021 +0530

    [DOCS] Add release specific docs update instructions (#96)
    
    * add branch specific instructions
---
 README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)

diff --git a/README.md b/README.md
index ecbd6d3..a684b7c 100644
--- a/README.md
+++ b/README.md
@@ -76,6 +76,62 @@ git push https://github.com/<id>/systemds-website update-website
 
 An example, [PR#83](https://github.com/apache/systemds-website/pull/83).
 
+### Release Docs
+
+Instruction for adding release specific version of docs to https://systemds.apache.org/docs
+
+**Step 0: Prerequisites**
+
+```sh
+git clone https://github.com/apache/systemds
+git clone https://github.com/apache/systemds-website
+```
+
+**Step 1:** 
+
+generate docs with as per https://github.com/apache/systemds/tree/master/docs
+
+```sh
+
+# In this case the release tag is 2.1.0-rc3
+git checkout 2.1.0-rc3
+
+cd systemds/docs
+
+./updateAPI.sh
+```
+
+**Step 2:**
+
+copy the contents to `systemds-website` repo
+
+```sh
+cd systemds-website
+
+# create a new directory with release no.
+mkdir content/docs/2.1.0
+
+# copy the files in docs/_site folder to 2.1.0
+cp -r ../systemds/docs/_site/* content/docs/2.1.0
+```
+
+Then follow, https://github.com/apache/systemds-website#updating-the-website
+
+**Step 3:**
+
+Open a PR against `asf-staging` branch.
+
+> Example PR: https://github.com/apache/systemds-website/pull/94
+
+Website Preview at https://systemds.staged.apache.org
+
+**Step 4:**
+
+Production release via `asf-site` branch. For this approval from the
+team is recommended.
+
+> Example PR: https://github.com/apache/systemds-website/pull/95
+
 
 ## How to add new dataset