[incubator-doris-website] 01/01: blank branch

[li...@apache.org]

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

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

commit dab11cd691c044ce6579d08adc59eed5fc5a1d37
Author: lide <li...@baidu.com>
AuthorDate: Tue Sep 25 19:34:55 2018 +0800

    blank branch
---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dec66d3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# Apache Incubator Website
+
+## Prerequisites
+
+The website is built using JBake and a Groovy template.
+The builds for the website do require internet access.
+
+- Install JBake from http://jbake.org/download.html
+- Create an environment variable `JBAKE_HOME` pointing to your JBake installation
+- Ensure that you have a JVM locally, e.g. [OpenJDK](http://openjdk.java.net/install/)
+
+## Clone the Source code
+
+If you have write access to incubator, you should clone it from https://git-wip-us.apache.org/repos/asf/incubator.git
+otherwise you can fork from our github mirror https://github.com/apache/incubator and raise a pull request.
+
+## Building & Running the site
+
+There is a custom `bake.sh` file that is used to build the website.
+You can call it with any of the [arguments you would pass to jbake](http://jbake.org/docs/2.5.1/#bake_command).
+The easiest way to use it is to run `./bake.sh -b -s`
+This will start up JBake in a watching mode as you make changes it will refresh after a short period of time.
+While working with it locally, you'll notice that the site URLs redirect to `incubator.apache.org`;
+to change this edit `jbake.properties` and uncomment the line referencing `localhost`
+
+## Automatic build and publishing - Jenkins Setup
+
+Commits to the `master` branch are automatically checked out and built using `build_site.sh`.
+
+The corresponding jenkins job can be found at [https://builds.apache.org/view/H-L/view/Incubator/job/Incubator%20Site/](https://builds.apache.org/view/H-L/view/Incubator/job/Incubator%20Site/)
+
+The result of the website build are pushed to the `asf-site` branch which are then published automatically using `gitwcsub`
+
+## Asciidoctor
+
+Most of the pages in the site are written using Asciidoctor.
+While it is a form of asciidoc it does have some [syntax differences that are worth reviewing](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/)
+
+## Groovy Templates
+
+The site templates are written in groovy scripts.
+Even though the files end with `.gsp` they are not GSP files and do not have access to tag libraries.
+You can run custom code in them, similar to what is done in [homepage.gsp](templates/homepage.gsp) .


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org