You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@yunikorn.apache.org by su...@apache.org on 2020/03/27 03:28:45 UTC

[incubator-yunikorn-site] branch site created (now 8e44370)

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

sunilg pushed a change to branch site
in repository https://gitbox.apache.org/repos/asf/incubator-yunikorn-site.git.


      at 8e44370  First Readme file

This branch includes the following new commits:

     new 8e44370  First Readme file

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



[incubator-yunikorn-site] 01/01: First Readme file

Posted by su...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

sunilg pushed a commit to branch site
in repository https://gitbox.apache.org/repos/asf/incubator-yunikorn-site.git

commit 8e44370b90b2c32da965e533d9021390e143e9fc
Author: Sunil G <su...@apache.org>
AuthorDate: Fri Mar 27 08:58:12 2020 +0530

    First Readme file
---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a96ac50
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Apache Yunikorn website
+
+This readme will walk you through building the yunikorn website
+
+## Introduction
+
+1. The `master` branch of the yunikorn is used to manage the website source code. Every time you modify the website, you need to submit it to the `master` branch for saving.
+
+2. The `asf-site` branch is used for the static page branch of the website. Every time you modify the website, you need to save the latest generated static page here. https://yunikorn.apache.org will be updated automatically.
+
+## Build website by docker
+
+```
+git clone https://github.com/apache/incubator-yunikorn-site.git
+git checkout master
+
+docker build -t yunikorn/yunikorn-website:1.0.0 .
+
+docker run -it -p 4000:4000 -v $PWD/yunikorn-site:/yunikorn-site yunikorn/yunikorn-website:1.0.0 bash
+cd /incubator-yunikorn-site
+bundle exec jekyll serve --watch --host=0.0.0.0
+```
+
+The static page of the website will be generated in the `$PWD/yunikorn-site/_site` directory.
+
+view yunikorn website in local: http://localhost:4000/
+
+## Adding a new page
+
+```
+rake page name="new-page.md"
+```
+
+## Deploy website
+
+1. Submit the `master` branch to github repo.
+2. Copy the `_site` directory to the other backup path, e.g., `back_site`.
+3. Switch to the `asf-site` branch, clear all the contents of the directory, copy the contents of the `back_site` directory to the this directory, and submit the `asf-site` branch to github repo.
+