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 0a29f8c [DOCS][MINOR] Jekyll docs update instructions
0a29f8c is described below
commit 0a29f8c14f2994a3652d8a2564a3e119ea7e2fd3
Author: Janardhan Pulivarthi <[email protected]>
AuthorDate: Mon Nov 1 10:50:28 2021 +0530
[DOCS][MINOR] Jekyll docs update instructions
---
README.md | 12 +++++++++++-
1 file changed, 11 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 15fa24a..c64fa49 100644
--- a/README.md
+++ b/README.md
@@ -108,6 +108,8 @@ git clone https://github.com/apache/systemds-website
generate docs with as per https://github.com/apache/systemds/tree/master/docs
+**1.1. API Documentation**
+
```sh
# In this case the release tag is 2.1.0-rc3
@@ -117,6 +119,14 @@ cd systemds/docs
./updateAPI.sh
```
+
+**1.2. Documentation website**
+
+```sh
+# Build jekyll based docs
+
+jekyll serve -w
+```
**Step 2:**
@@ -129,7 +139,7 @@ cd systemds-website
mkdir content/docs/2.1.0
# copy the files in docs/_site folder to 2.1.0
-cp -r ../systemds/docs/api content/docs/2.1.0
+cp -r ../systemds/docs/_site/* content/docs/2.1.0
```
Then follow, https://github.com/apache/systemds-website#updating-the-website
