Main Landing Page

The main homepage of PMDhttps://pmd.github.io is hosted by Github Pages.

The repository ishttps://github.com/pmd/pmd.github.io.

It usesJekyll to generate the static html pages. Jekyll isexecuted by github for every push to the repository. Please note, that it takes some timeuntil Jekyll has been executed and due to caching, the homepage is not updated immediately.It usually takes 15 minutes.

Contents

• Main page - aka “Landing page”:https://pmd.github.io
  • Layout:_layouts/default.html.It includes all the sub section, which can be found in the includes directory_includes/
  • The latest PMD version is configured in_config.yml and the variablessite.pmd.latestVersion are usede.g. in_includes/home.html.
• Blog - aka “News”:https://pmd.github.io/news/
  • This is a section on main page. It shows the 5 latest news. See_includes/news.html.
  • There is also a sub page “news” which lists all news.
    • Layout:_layouts/news.html
    • Page (which is pretty empty):news.html

Building the page locally

Since the repository contains the documentation for many old PMD releases, it is quite big. When executingJekyll to generate the site, it copies all the files to the folder_site/ - and this can take a while.

In order to speed things up locally, consider to addpmd-* to the exclude patterns in_config.yml. Seealso the comments in this file.

Then it is a matter of simply executingbundle exec jekyll serve. This will generate the site and hostit on localhost, so you can test the page athttp://127.0.0.1:4000.

Updates during a release

When creating a new PMD release, some content of the main page need to be updated as well.This done as part of theRelease process, but issummarized here as well:

• The versions (e.g.pmd.latestVersion) needs to be updated in_config.yml
  • This is needed to generate the correct links and texts for the latest version on landing page
• The new PMD documentation needs to be copied to/pmd-<version>/
• Then this folder needs to copied to/latest/, actually replacing the old version.
• A new blog post with release notes is added:/_posts/YYYY-mm-dd-PMD-<version>.md
• The sitemapsitemap.xml is regenerated

Some of these steps are automated throughdo-release.sh (like blog post), some are manual steps(updating the version in _config.yml) and other steps are done on the travis-ci-build (likecopying the new documentation).

Adding a new blog post

Adding a new blog post is as easy as:

• Creating a new file in the folder “_posts”:/_posts/YYYY-mm-dd-<title>.md
• The file name needs to fit this pattern. The date of the blog post is taken from the file name. The “
• The file is a markdown file starting with a frontmatter for jekyll. Just use this template for the new file:

---layout: posttitle: Title---Here comes the text

Once you commit and push it, Github will run Jekyll and update the page. The Jekyll templates take care thatthe new post is recognized and added to the news section and also on the news subpage.