Mirror of Apache incubator Tamaya Website
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
bin
content
discuss
howto/blog
templates
.gitignore
LICENSE
NOTICE
README.md
bake-jenkins.sh
bake.sh
copysite.sh
jbake.properties

README.md

Apache Tamaya Incubating SITE repository

This repository contains the homepage of Apache Tamaya (incubating). We are using jBake to generate a static page. It is enhanced by maven-generated artifacts such as Javadoc.

Current status

The repository is linked to the live web page at https://tamaya.incubator.apache.org/ after migration started in 2016-09.

Available branches

Master branch

Contains the jbake original files and all binaries (images, fonts, static JS) and the base contents.

Templates

All Thymeleaf-based 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://tamaya.incubator.apache.org/jbake/ as requested via https://issues.apache.org/jira/browse/INFRA-12814

How to generate a new page

Locally

In case you want to play with homepage locally:

  1. Clone this repository.
  2. Launch the bash script
$ ./bake.sh
  1. Point your browser to http://localhost:8820/

Remote

You need write access to this repository and have to generate the javadoc manually!

  1. Generate Javadoc for Tamaya Core
$ cd tamaya
$ git checkout master (to generate the current development version) OR
$ git checkout 0.3-incubating (to generate the a stable release version)
$ mvn site
(since javadoc:javadoc does not generate a full report)
  1. Launch the bash script to generate the homepage and switch the the asf branch:
$ git checkout master
$ ./copysite.sh
  1. Make sure you are on branch asf-site! Copy the generated Javadoc into apidocs
$ git checkout asf-site
$ cd apidocs
$ cp -r pathToTamayaCoreRepo/target/site/apidocs/* ./development/ - for current master version OR
$ cp -r pathToTamayaCoreRepo/target/site/apidocs/* ./stable/ - for released/stable version(s)
  1. Push your changes
$ git push
  1. Wait a couple of minutes for the gitpubsub to happen.
  2. Go to https://tamaya.incubator.apache.org in your browser

Jenkins / CI integration

There is a daily build job that triggers a site baking on ASF-Jenkins: https://builds.apache.org/view/S-Z/view/Tamaya/job/Tamaya-Site-jBake-Master/