You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@incubator.apache.org by po...@apache.org on 2017/07/06 00:21:10 UTC
[39/51] incubator git commit: Create a README to give some
instructions on how to get setup with the site. Removed unneeded file.
Create a README to give some instructions on how to get setup with the site. Removed unneeded file.
Project: http://git-wip-us.apache.org/repos/asf/incubator/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator/commit/d1fcec56
Tree: http://git-wip-us.apache.org/repos/asf/incubator/tree/d1fcec56
Diff: http://git-wip-us.apache.org/repos/asf/incubator/diff/d1fcec56
Branch: refs/heads/master
Commit: d1fcec5604321197f3eecc423b238efdb7968a3b
Parents: 9e2a80b
Author: John D. Ament <jo...@apache.org>
Authored: Sat Jun 17 17:12:24 2017 -0400
Committer: John D. Ament <jo...@apache.org>
Committed: Sat Jun 17 17:12:24 2017 -0400
----------------------------------------------------------------------
README.md | 28 ++++++++++++++++++++++++++++
jbake.properties | 1 +
replacements | 2 --
3 files changed, 29 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator/blob/d1fcec56/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..728dffc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# 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/)
+
+## 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`
+
+## Jenkins Setup
+
+Commits to the `jbake-site` branch are automatically checked out and built using `build_site.sh`. Once this goes live those commits will go against `master`. The 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 commits are pushed to the `asf-site` branch which are then published 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)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator/blob/d1fcec56/jbake.properties
----------------------------------------------------------------------
diff --git a/jbake.properties b/jbake.properties
index 66d6b9a..7f4994b 100644
--- a/jbake.properties
+++ b/jbake.properties
@@ -1,4 +1,5 @@
site.host=https://incubator.apache.org/ngtest
+#site.host=http://localhost:8820
render.tags=false
render.sitemap=true
template.homepage.file=homepage.gsp
http://git-wip-us.apache.org/repos/asf/incubator/blob/d1fcec56/replacements
----------------------------------------------------------------------
diff --git a/replacements b/replacements
deleted file mode 100644
index 2f62293..0000000
--- a/replacements
+++ /dev/null
@@ -1,2 +0,0 @@
-Input: <a href=('|")(.+)('|")>(.+)</a>
-Output: link:$2[$4]
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@incubator.apache.org
For additional commands, e-mail: cvs-help@incubator.apache.org