tamaya-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pottlin...@apache.org
Subject incubator-tamaya-site git commit: TAMAYA-178: Add howto to work with the new homepage
Date Mon, 09 Jan 2017 21:53:37 GMT
Repository: incubator-tamaya-site
Updated Branches:
  refs/heads/master 7a5bf27e6 -> 137da6bfd


TAMAYA-178: Add howto to work with the new homepage

* Improved documentation about structure of the project and what to put where


Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/137da6bf
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/137da6bf
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/137da6bf

Branch: refs/heads/master
Commit: 137da6bfd15a6bbfdc4e9e29f4ec3682bb6c120c
Parents: 7a5bf27
Author: Phil Ottlinger <pottlinger@apache.org>
Authored: Mon Jan 9 22:52:53 2017 +0100
Committer: Phil Ottlinger <pottlinger@apache.org>
Committed: Mon Jan 9 22:52:53 2017 +0100

----------------------------------------------------------------------
 README.md | 38 +++++++++++++++++++++++++++++++-------
 1 file changed, 31 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/137da6bf/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 5e2a93f..ef1cde1 100644
--- a/README.md
+++ b/README.md
@@ -9,27 +9,51 @@ We are using jBake to generate a static page. It is enhanced by maven-generated
 * As of 2016-09 we started to migrate to a jbake setup since the maven-generated site was
based on a deprecated maven skin and had SSL problems.
 * Current working status: https://issues.apache.org/jira/browse/TAMAYA-178
 
+### 2017-01
+
+All old static pages are regenerated. Ready to add current contents and blog posts about
the past of the project :-)
+
 ## Available branches
 ### Master branch
 
 Contains the jbake original files and all binaries (images, fonts, static JS) and the base
contents.
 
-tbd:
-* basic file layout?
-* what goes where?
+#### Templates
+
+All [Thymeleaf-based](http://www.thymeleaf.org/) page templates can be found in the `templates`
directory. These templates are footer, header and menu of the website.
+
+#### Template variables
+
+All variables are defined in `jbake.properties`
+
+#### Static assets
+
+Images, CSS and JS have to be put in the `assets` subfolder.
+
+#### Other resources
+
+All of the contents goes in `content`. The directory structure defines the menu subitems
when the website is baked.
+
+#### jBake itself
+
+A full installation of jBake is checked in under `bin` in order to be able to reproducable
generate the pages even if there is a problem with the project, internet or something else.
It's meant as a matter of convenience and security.
+
+#### Generated contents
+
+Please do not check in the `output` directory as it contains the baked homepage! It needs
to be checked in with a different structure in the branch `asf-site`!
 
 ### ASF-site branch
 
 Is linked to
 https://issues.apache.org/jira/browse/INFRA-12814
 ://tamaya.incubator.apache.org/jbake/
-as requested via ttps://issues.apache.org/jira/browse/INFRA-12814 
+as requested via ttps://issues.apache.org/jira/browse/INFRA-12814
 
 ### How to generate a new page
 
 #### Locally
 
-tbd
+In case you want to play with homepage locally:
 
 1. Clone this repository.
 1. Launch the bash script
@@ -40,7 +64,7 @@ $ ./bake.sh
 
 #### Remote
 
-tbd
+You need write access to this repository and have to generate the javadoc manually!
 
 1. Generate Javadoc for Tamaya Core
 ```
@@ -63,7 +87,7 @@ $ cp -r pathToTamayaCoreRepo/target/site/apidocs .
 $ git push
 ```
 1. Wait a couple of minutes for the gitpubsub to happen.
-1. Go to xyz/tbd in your browser
+1. Go to https://tamaya.incubator.apache.org/jbake/ in your browser
 
 #### Jenkins / CI integration
 


Mime
View raw message