⚠️ This project is now part of the EE4J initiative. This repository has been archived as all activities are now happening in the corresponding Eclipse repository. See here for the overall EE4J transition status.
The gh-pages branch of this repo contains all the initial assets for a simple site that can be easily customized for any Java EE related project. The site will be hosted in a specific branch of the given project and will be generated by GitHub Pages. Check https://javaee.github.io/website-template/ to see how this sample site looks like.
-
Clone your project repo
⚠️ Make sure the master branch of your project contains both CONTRIBUTING.md (see here) and LICENSE.md (see here for the standard GF GPLv2/CPE/CDDL). Do not change CONTRIBUTING.md; if you want to have specific contributing technical guidelines for your project, we recommend to have those in a separate file. -
Create the orphan gh-pages branch that will host your site
git checkout --orphan gh-pages- You might want to delete unnecessary files.
⚠️ In any case, CONTRIBUTING.MD and LICENSE.md shoud be in both branches!
git rm --cached -r stuff_to_delete- Grab all the initial assets from this repo gh-pages branch and push them to your repo gh-pages branch. Make sure to not overwrite CONTRIBUTING.md and LICENSE.md!
git add *
git commit
git push --set-upstream origin gh-pages -
Configure your website, edit README.md (the main page) and _config.yml which contains project specific values (project name, tag line, repo URL, doc URL ...).
-
Test your site. Via your project 'setting' tab, you can get its URL and check the GH-Pages site build status.