Fix toc links

(cherry picked from commit 40f0c4d59b)

.github/ISSUE_TEMPLATE.md

@@ -1,6 +1,9 @@
-Please, prefix the report title with the language it applies to within brackets, such as *[java]* or *[apex]*. If not specific to a language, you can use *[core]*
+<!-- Please, prefix the report title with the language it applies to within brackets, such as [java] or [apex].
+If not specific to a language, you can use [core]. -->
 
-**Rule Set:**
+**Affects PMD Version:** 
+
+**Rule:**
 
 **Description:**
 
@@ -12,3 +15,4 @@ Please, prefix the report title with the language it applies to within brackets,
 
 **Running PMD through:** *[CLI | Ant | Maven | Gradle | Designer | Other]*
 
+<!-- If relevant, also include your JDK and OS information, e.g. for ClassNotFoundException, LinkageError, reflection failures, etc. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,8 +2,9 @@ Please, prefix the PR title with the language it applies to within brackets, suc
 
 Before submitting a PR, please check that:
  - [ ] The PR is submitted against `master`. The PMD team will merge back to support branches as needed.
- - [ ] `mvn test` passes.
- - [ ] `mvn checkstyle:check` passes. [Check this for more info](https://github.com/pmd/pmd/blob/master/CONTRIBUTING.md#code-style)
+ - [ ] `./mvnw test` passes.
+ - [ ] `./mvnw pmd:check` passes.
+ - [ ] `./mvnw checkstyle:check` passes. [Check this for more info](https://github.com/pmd/pmd/blob/master/CONTRIBUTING.md#code-style)
 
 **PR Description:**
 

.gitignore

@@ -10,3 +10,4 @@ bin/
 .idea
 *.patch
 */src/site/site.xml
+pmd-core/dependency-reduced-pom.xml

.mvn/wrapper/maven-wrapper.properties

@@ -1 +1 @@
-distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.5.0/apache-maven-3.5.0-bin.zip
+distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.5.4/apache-maven-3.5.4-bin.zip

.travis.yml

@@ -1,16 +1,11 @@
+dist: trusty
 sudo: false
-
 addons:
-  apt:
-    packages:
-      - oracle-java8-installer
   ssh_known_hosts:
     - web.sourceforge.net
 
 language: java
 
-jdk: oraclejdk8
-
 env:
   global:
   - secure: KBEuB6U1p5RQXSYe157AwydFr/zpXQPA0IChVCgZV+X1mMyy9ZtrjH1J1AXuviseDDXDbaT25sRnsvpl82rfRw2xOkMGXHy4N95/ylTSr8DjHxTao71BhXsvFycNobFva5y2EGNWqDvpS8I2oSZo7Qk4la3yep3rcJQvcy6RDbbhpDTbL1QMFyadunIBm0WtqbunrMqtjSqaoPsXz8TiQuxHvX4vEXzVbaxV1QQt79Vi+daa6wAV3mRQAugnx+UffsC8JqMxgm06usWeJgCJzxgm8E7clZCLmf53B2TL8dK6bIYbqyvOY3uFxitsTG0d8Z0GOJwXBgZNgbniTRO8ZJSty5eZP8LBybbjVLSL25DNTWtCjADUL/uySnXIEidlMt2N/3QmH7zrGAfAk/tIwKpdRca2GLLydeXf6PSkiahnPEkIY/QupcsOLELhdifpdOjb8QW1OenA+vUbNM9dccLwKnX6Fj9cu4VQG601AcYDr2eyhq8WYkr3wYdw/6KdUa3hmplowTBs+qguppP+eOSgGuEsy38KLtqnvm6WlHy6tcLmcVYKG3DmR1b7TWXsOXC6/VMH8BHBkvsF1QdRg9+Cgx07vX3Hw7roPiYzmaO9Ajs20ATsUfRskMuWCTeTSK5pN8X27veRCZlhFjeKQMDdmfVwzpAfRgKsl3TEn1I=
@@ -23,15 +18,21 @@ env:
   - secure: "JIhuqaI0i+zvuqqXiQBHpuKr7AQ8jfk6Gbr8Qgiq4yJtdEWXZGxnAT9BmlbjkgT7ABXvLgxf2CIdUOMo1yYfBlxQL/y5+e89jaVpYF3tvNAzYQ1e12VzQRsd/jDb7qvm7tw3rDHEn3dSEot7Q6KbPcL6WzWJINVMCCmOgvq9gKHgE6Y5q5EgZ5rxiXyuO27ndzcbxaor4PIaiSzHO9+AJQ7p2zDLP+kG4nKVTBX0l9VoKiYFhIpIhpbigi3jyLDMDRiWpwTWZC6P8/RXfZg/lc5ADOuM2DM8oXPpZuqOa/g31LWQOSCuEnQ1G16vbLgipSPpgAc7jYWD5cywhG9dLkiKaZDh5x0meLM2RoAgz6eAnQfTTqJ68OM9o9yXjubEedsNpNRAr9/DXMd+fbh10W2vbvL5HCNB3lic3anehhR9le7PLuEKxg654wXt3KM2PZGVWbotIyBK0CvGzqGkppvwT23QdDDqSdkWuGQIhGQ0xBOdYkwebycxP5wwPUmObG+mymQ1Be2BXvmghttsiJdKlt4CVSYOJUMus6kU32G95hdTgKblsX4J1Of2i1nYsjyMKh3k945tqXwQrIsxOOQug0oIkz24zlLaOaQcorWtJ6Y1HPaZKpVIFUEF0y8Uq/O4oB2bOYC6WDUQfpj7nRG6xbi+BeBS84m1ttCEk4g="
   matrix:
   - BUILD=deploy
-  - BUILD=site
+  - BUILD=doc
   - BUILD=sonar
+  - BUILD=coveralls
+
+matrix:
+  fast_finish: true
 
 before_install:
+  - wget https://github.com/sormuras/bach/raw/master/install-jdk.sh
   - bash .travis/setup-secrets.sh
   - bash .travis/configure-maven.sh
-install: true
+# Install OracleJDK 10 - see https://sormuras.github.io/blog/2018-03-20-jdk-matrix.html
+install: . ./install-jdk.sh -F 10 -L BCL
 before_script: true
-script: bash .travis/build-$BUILD.sh
+script: source .travis/build-$BUILD.sh
 after_success: true
 
 
@@ -42,7 +43,7 @@ deploy:
   file_glob: true
   file:
   - pmd-dist/target/pmd-*.zip
-  - target/pmd-doc-*.zip
+  - docs/pmd-doc-*.zip
   skip_cleanup: true
   on:
     tags: true
@@ -51,10 +52,17 @@ deploy:
 after_deploy: bash .travis/release.sh
 
 notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/0e6dd310db54b96c2653
+      - https://webhooks.gitter.im/e/65efc1ea65175ad23ab6
+    on_success: always  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: never     # options: [always|never|change] default: always
   email:
     recipients:
-    - adangel@users.sourceforge.net
-    on_success: always
+    - andreas.dangel@adangel.org
+    on_success: change
     on_failure: always
 cache:
   directories:

.travis/background-job-funcs.sh

@@ -1,43 +0,0 @@
-#
-# Helper functions to run a chatty, long task in the background,
-# redirecting the output to file and keep travis happy by regularly
-# writing to the log.
-#
-# This is to workaround the travis log length limit of 4MB
-# Solution from http://stackoverflow.com/questions/26082444/how-to-work-around-travis-cis-4mb-output-limit/26082445#26082445
-#
-# Source this file into the shell script, that needs it.
-#
-# expected variables
-# Name          |   Example Value
-# PING_SLEEP    |   30s
-# BUILD_OUTPUT  |   /tmp/build-step-logfile.out
-# PING_PID_FILE |   /tmp/build-step-ping.pid
-
-touch $BUILD_OUTPUT
-
-dump_output() {
-   echo Tailing the last 100 lines of output:
-   tail -100 $BUILD_OUTPUT
-}
-kill_ping() {
-  if [ -e $PING_PID_FILE ]; then
-    PING_LOOP_PID=$(cat $PING_PID_FILE)
-    kill $PING_LOOP_PID
-    rm $PING_PID_FILE
-  fi
-}
-error_handler() {
-  kill_ping
-  echo ERROR: An error was encountered with the build.
-  dump_output
-  exit 1
-}
-# If an error occurs, run our error handler to output a tail of the build
-trap 'error_handler' ERR
-
-# Set up a repeating loop to send some output to Travis.
-bash -c "while true; do echo \$(date) - building ...; sleep $PING_SLEEP; done" &
-PING_LOOP_PID=$!
-echo "$PING_LOOP_PID" > $PING_PID_FILE
-

.travis/build-coveralls.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+set -e
+
+source .travis/logger.sh
+source .travis/common-functions.sh
+
+VERSION=$(./mvnw -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec | tail -1)
+log_info "Building PMD Coveralls.io report ${VERSION} on branch ${TRAVIS_BRANCH}"
+
+if ! travis_isPush; then
+    echo "Not proceeding, since this is not a push!"
+    exit 0
+fi
+
+#
+# for java9: enable all modules.
+# coveralls plugin seems to need java.xml.bind module
+echo "MAVEN_OPTS='-Xms1g -Xmx1g --add-modules java.se.ee'" > ${HOME}/.mavenrc
+
+(
+    # disable fast fail, exit immediately, in this subshell
+    set +e
+
+    ./mvnw clean install -DskipTests=true -Dmaven.javadoc.skip=true -B -V
+    ./mvnw test jacoco:report coveralls:report -Pcoveralls -B -V
+
+    if [ $? -ne 0 ]; then
+        log_error "Error creating coveralls report"
+    else
+        log_success "New coveralls result: https://coveralls.io/github/pmd/pmd"
+    fi
+    true
+)

.travis/build-deploy.sh

@@ -1,37 +1,78 @@
 #!/bin/bash
 set -e
 
+source .travis/logger.sh
 source .travis/common-functions.sh
 
+function push_docs() {
+    if git diff --quiet docs; then
+        log_info "No changes in docs..."
+    else
+        log_info "Found changes in docs..."
+
+        if [ "$TRAVIS_BRANCH" == "master" ]; then
+            git config user.name "Travis CI (pmd-bot)"
+            git config user.email "andreas.dangel+pmd-bot@adangel.org"
+            git add -A docs
+            git commit -m "Update documentation"
+            git push git@github.com:pmd/pmd.git HEAD:master
+            log_success "Successfully pushed docs update"
+        else
+            log_info "Not on master branch, won't commit+push"
+        fi
+    fi
+}
+
+
 VERSION=$(./mvnw -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec | tail -1)
-echo "Building PMD ${VERSION} on branch ${TRAVIS_BRANCH}"
+log_info "Building PMD ${VERSION} on branch ${TRAVIS_BRANCH}"
+
+MVN_BUILD_FLAGS="-B -V"
 
 if travis_isPullRequest; then
 
-    echo "This is a pull-request build"
-    ./mvnw verify -B -V
+    log_info "This is a pull-request build"
+    ./mvnw verify $MVN_BUILD_FLAGS
 
 elif travis_isPush; then
 
-    if [[ "$VERSION" != *-SNAPSHOT && "$TRAVIS_TAG" != "" ]]; then
-        echo "This is a release build for tag $TRAVIS_TAG"
-        ./mvnw deploy -Possrh,pmd-release -B -V
-    elif [[ "$VERSION" == *-SNAPSHOT ]]; then
-        echo "This is a snapshot build"
-        ./mvnw deploy -Possrh -B -V
+    if [[ "${VERSION}" != *-SNAPSHOT && "${TRAVIS_TAG}" != "" ]]; then
+        echo -e "\n\n"
+        log_info "This is a release build for tag ${TRAVIS_TAG}"
+        echo -e "\n\n"
+        ./mvnw deploy -Possrh,pmd-release $MVN_BUILD_FLAGS
+    elif [[ "${VERSION}" == *-SNAPSHOT ]]; then
+        log_info "This is a snapshot build"
+        ./mvnw deploy -Possrh $MVN_BUILD_FLAGS
+        push_docs
     else
         # other build. Can happen during release: the commit with a non snapshot version is built, but not from the tag.
-        echo "This is some other build, probably during release: commit with a non-snapshot version on branch master..."
-        ./mvnw verify -Possrh -B -V
+        log_info "This is some other build, probably during release: commit with a non-snapshot version on branch master..."
+        ./mvnw verify $MVN_BUILD_FLAGS
         # we stop here - no need to execute further steps
         exit 0
     fi
 
-    # Uploading pmd distribution to sourceforge
-    rsync -avh pmd-dist/target/pmd-*-${VERSION}.zip ${PMD_SF_USER}@web.sourceforge.net:/home/frs/project/pmd/pmd/${VERSION}/
-    rsync -avh src/site/markdown/overview/changelog.md ${PMD_SF_USER}@web.sourceforge.net:/home/frs/project/pmd/pmd/${VERSION}/ReadMe.md
+    (
+        # disable fast fail, exit immediately, in this subshell
+        set +e
+
+        echo -e "\n\n"
+        log_info "Uploading pmd distribution to sourceforge..."
+        rsync -avh pmd-dist/target/pmd-*-${VERSION}.zip ${PMD_SF_USER}@web.sourceforge.net:/home/frs/project/pmd/pmd/${VERSION}/
+        if [ $? -ne 0 ]; then
+            log_error "Error while uploading pmd-*-${VERSION}.zip to sourceforge!"
+            log_error "Please upload manually: https://sourceforge.net/projects/pmd/files/pmd/"
+        fi
+        rsync -avh docs/pages/release_notes.md ${PMD_SF_USER}@web.sourceforge.net:/home/frs/project/pmd/pmd/${VERSION}/ReadMe.md
+        if [ $? -ne 0 ]; then
+            log_error "Error while uploading release_notes.md as ReadMe.md to sourceforge!"
+            log_error "Please upload manually: https://sourceforge.net/projects/pmd/files/pmd/"
+        fi
+        true
+    )
 
 else
-    echo "This is neither a pull request nor a push!"
+    log_info "This is neither a pull request nor a push. Not executing any build."
     exit 1
 fi

.travis/build-doc.sh

@@ -0,0 +1,82 @@
+#!/bin/bash
+set -e
+
+source .travis/logger.sh
+source .travis/common-functions.sh
+
+VERSION=$(./mvnw -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec | tail -1)
+log_info "Building PMD Documentation ${VERSION} on branch ${TRAVIS_BRANCH}"
+
+if ! travis_isPush; then
+    log_info "Not building site, since this is not a push!"
+    exit 0
+fi
+
+pushd docs
+
+# run jekyll
+echo -e "\n\n"
+log_info "Building documentation using jekyll..."
+bundle install
+bundle exec jekyll build
+
+# create pmd-doc archive
+echo -e "\n\n"
+log_info "Creating pmd-doc archive..."
+mv _site pmd-doc-${VERSION}
+zip -qr pmd-doc-${VERSION}.zip pmd-doc-${VERSION}/
+
+(
+    # disable fast fail, exit immediately, in this subshell
+    set +e
+
+    if [[ "${TRAVIS_TAG}" != "" || "${VERSION}" == *-SNAPSHOT ]]; then
+        echo -e "\n\n"
+        log_info "Uploading pmd doc distribution to sourceforge..."
+        rsync -avh pmd-doc-${VERSION}.zip ${PMD_SF_USER}@web.sourceforge.net:/home/frs/project/pmd/pmd/${VERSION}/
+        if [ $? -ne 0 ]; then
+            log_error "Couldn't upload pmd-doc-${VERSION}.zip!"
+            log_error "Please upload manually: https://sourceforge.net/projects/pmd/files/pmd/"
+        fi
+    fi
+
+    # rsync site to pmd.sourceforge.net/snapshot
+    if [[ "${VERSION}" == *-SNAPSHOT && "${TRAVIS_BRANCH}" == "master" ]] && has_docs_change; then
+        echo -e "\n\n"
+        log_info "Uploading snapshot site to pmd.sourceforge.net/snapshot..."
+        travis_wait rsync -ah --stats --delete pmd-doc-${VERSION}/ ${PMD_SF_USER}@web.sourceforge.net:/home/project-web/pmd/htdocs/snapshot/
+        if [ $? -ne 0 ]; then
+            log_error "Couldn't upload the snapshot documentation. It won't be current on http://pmd.sourceforge.net/snapshot/"
+        else
+            log_success "Successfully uploaded snapshot documentation: http://pmd.sourceforge.net/snapshot/"
+        fi
+    fi
+
+    true
+)
+
+
+
+#
+# Push the generated site to gh-pages branch
+#
+if [[ "${VERSION}" == *-SNAPSHOT && "${TRAVIS_BRANCH}" == "master" ]] && has_docs_change; then
+    echo -e "\n\n"
+    log_info "Pushing the new site to github pages..."
+    git clone --branch gh-pages --depth 1 git@github.com:pmd/pmd.git pmd-gh-pages
+    # clear the files first
+    rm -rf pmd-gh-pages/*
+    # copy the new site
+    cp -a pmd-doc-${VERSION}/* pmd-gh-pages/
+    (
+        cd pmd-gh-pages
+        git config user.name "Travis CI (pmd-bot)"
+        git config user.email "andreas.dangel+pmd-bot@adangel.org"
+        git add -A
+        git commit -q -m "Update documentation"
+        git push git@github.com:pmd/pmd.git HEAD:gh-pages
+        log_success "Successfully pushed site to https://pmd.github.io/pmd/"
+    )
+fi
+
+popd

.travis/build-site.sh

@@ -1,63 +0,0 @@
-#!/bin/bash
-set -e
-
-source .travis/common-functions.sh
-
-VERSION=$(./mvnw -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec | tail -1)
-echo "Building PMD Site ${VERSION} on branch ${TRAVIS_BRANCH}"
-
-if ! travis_isPush; then
-    echo "Not building site, since this is not a push!"
-    exit 0
-fi
-
-
-(
-    export PING_SLEEP=30s
-    export BUILD_OUTPUT=/tmp/build-site.out
-    export PING_PID_FILE=/tmp/build-site-ping.pid
-
-    source .travis/background-job-funcs.sh
-
-    # Run the build, redirect output into the file
-    ./mvnw install -DskipTests=true -B -V >> $BUILD_OUTPUT 2>&1
-    ./mvnw site site:stage -Psite -B -V >> $BUILD_OUTPUT 2>&1
-
-    # The build finished without returning an error so dump a tail of the output
-    dump_output
-
-    # nicely terminate the ping output loop
-    kill_ping
-)
-
-# create pmd-doc archive
-(
-    cd target
-    mv staging pmd-doc-${VERSION}
-    zip -qr pmd-doc-${VERSION}.zip pmd-doc-${VERSION}/
-)
-
-# Uploading pmd doc distribution to sourceforge
-if [[ "$TRAVIS_TAG" != "" || "$VERSION" == *-SNAPSHOT ]]; then
-    rsync -avh target/pmd-doc-${VERSION}.zip ${PMD_SF_USER}@web.sourceforge.net:/home/frs/project/pmd/pmd/${VERSION}/
-fi
-
-(
-    if [[ "$VERSION" == *-SNAPSHOT && "$TRAVIS_BRANCH" == "master" ]]; then
-        # this can take very long and no output is generated. therefore use the background job again
-        export PING_SLEEP=30s
-        export BUILD_OUTPUT=/tmp/build-site-upload.out
-        export PING_PID_FILE=/tmp/build-site-upload-ping.pid
-
-        source .travis/background-job-funcs.sh
-
-        # Uploading snapshot site...
-        rsync -ah --stats --delete target/pmd-doc-${VERSION}/ ${PMD_SF_USER}@web.sourceforge.net:/home/project-web/pmd/htdocs/snapshot/
-
-        # The build finished without returning an error so dump a tail of the output
-        dump_output
-
-        # nicely terminate the ping output loop
-        kill_ping
-    fi
-)

.travis/build-sonar.sh

@@ -1,29 +1,33 @@
 #!/bin/bash
 set -e
 
+source .travis/logger.sh
 source .travis/common-functions.sh
 
 VERSION=$(./mvnw -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec | tail -1)
-echo "Building PMD Sonar ${VERSION} on branch ${TRAVIS_BRANCH}"
+log_info "Building PMD Sonar ${VERSION} on branch ${TRAVIS_BRANCH}"
 
 if ! travis_isPush; then
     echo "Not updating sonar, since this is not a push!"
     exit 0
 fi
 
+#
+# for java9: enable all modules.
+# sonar plugin seems to need java.xml.bind module
+echo "MAVEN_OPTS='-Xms1g -Xmx1g --add-modules java.se.ee'" > ${HOME}/.mavenrc
 
-export PING_SLEEP=30s
-export BUILD_OUTPUT=/tmp/build-sonar.out
-export PING_PID_FILE=/tmp/build-sonar-ping.pid
+(
+    # disable fast fail, exit immediately, in this subshell
+    set +e
 
-source .travis/background-job-funcs.sh
-
-# Run the build, redirect output into the file
-./mvnw clean org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar -Dsonar.host.url=https://sonarqube.com -Dsonar.login=${SONAR_TOKEN} -B -V >> $BUILD_OUTPUT 2>&1
-
-# The build finished without returning an error so dump a tail of the output
-dump_output
-
-# nicely terminate the ping output loop
-kill_ping
+    # Run the build
+    ./mvnw clean org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar -Dsonar.host.url=https://sonarcloud.io -Dsonar.login=${SONAR_TOKEN} -B -V
 
+    if [ $? -ne 0 ]; then
+        log_error "Error updating sonar..."
+    else
+        log_success "New sonar results: https://sonarcloud.io/dashboard?id=net.sourceforge.pmd%3Apmd"
+    fi
+    true
+)

.travis/common-functions.sh

@@ -2,18 +2,17 @@
 set -e
 
 
-echo "TRAVIS_REPO_SLUG: $TRAVIS_REPO_SLUG"
-echo "TRAVIS_PULL_REQUEST_SLUG: $TRAVIS_PULL_REQUEST_SLUG"
-echo "TRAVIS_PULL_REQUEST_BRANCH: $TRAVIS_PULL_REQUEST_BRANCH"
-echo "TRAVIS_PULL_REQUEST: $TRAVIS_PULL_REQUEST"
-echo "TRAVIS_SECURE_ENV_VARS: $TRAVIS_SECURE_ENV_VARS"
-echo "TRAVIS_BRANCH: $TRAVIS_BRANCH"
-echo "TRAVIS_TAG: $TRAVIS_TAG"
-echo "TRAVIS_ALLOW_FAILURE: $TRAVIS_ALLOW_FAILURE"
-
+echo "TRAVIS_REPO_SLUG: ${TRAVIS_REPO_SLUG}"
+echo "TRAVIS_PULL_REQUEST_SLUG: ${TRAVIS_PULL_REQUEST_SLUG}"
+echo "TRAVIS_PULL_REQUEST_BRANCH: ${TRAVIS_PULL_REQUEST_BRANCH}"
+echo "TRAVIS_PULL_REQUEST: ${TRAVIS_PULL_REQUEST}"
+echo "TRAVIS_SECURE_ENV_VARS: ${TRAVIS_SECURE_ENV_VARS}"
+echo "TRAVIS_BRANCH: ${TRAVIS_BRANCH}"
+echo "TRAVIS_TAG: ${TRAVIS_TAG}"
+echo "TRAVIS_ALLOW_FAILURE: ${TRAVIS_ALLOW_FAILURE}"
 
 function travis_isPullRequest() {
-    if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
+    if [ "${TRAVIS_REPO_SLUG}" != "pmd/pmd" ] || [ "${TRAVIS_PULL_REQUEST}" != "false" ]; then
         return 0
     else
         return 1
@@ -21,9 +20,19 @@ function travis_isPullRequest() {
 }
 
 function travis_isPush() {
-    if [ "$TRAVIS_PULL_REQUEST" = "false" ] && [ "${TRAVIS_SECURE_ENV_VARS}" = "true" ]; then
+    if [ "${TRAVIS_REPO_SLUG}" = "pmd/pmd" ] && [ "${TRAVIS_PULL_REQUEST}" = "false" ] && [ "${TRAVIS_SECURE_ENV_VARS}" = "true" ]; then
         return 0
     else
         return 1
     fi
 }
+
+function has_docs_change() {
+    if [[ $(git diff --name-only ${TRAVIS_COMMIT_RANGE}) = *"docs/"* ]]; then
+        log_info "Checking for changes in docs/ (TRAVIS_COMMIT_RANGE=${TRAVIS_COMMIT_RANGE}): changes found"
+        return 0
+    else
+        log_info "Checking for changes in docs/ (TRAVIS_COMMIT_RANGE=${TRAVIS_COMMIT_RANGE}): no changes"
+        return 1
+    fi
+}

.travis/configure-maven.sh

@@ -1,7 +1,6 @@
 #!/bin/bash
 set -e
 
-echo "MAVEN_OPTS='-Xms1g -Xmx1g'" > $HOME/.mavenrc
-mkdir -p $HOME/.m2
-cp .travis/travis-toolchains.xml $HOME/.m2/toolchains.xml
-cp .travis/travis-settings.xml $HOME/.m2/settings.xml
+echo "MAVEN_OPTS='-Xms1g -Xmx1g'" > ${HOME}/.mavenrc
+mkdir -p ${HOME}/.m2
+cp .travis/travis-settings.xml ${HOME}/.m2/settings.xml

.travis/logger.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+COL_GREEN="\e[32m"
+COL_RED="\e[31m"
+COL_RESET="\e[0m"
+COL_YELLOW="\e[33;1m"
+
+function log_error() {
+    echo -e "${COL_RED}[ERROR] $*${COL_RESET}"
+}
+
+function log_info() {
+    echo -e "${COL_YELLOW}[INFO] $*${COL_RESET}"
+}
+
+function log_success() {
+    echo -e "${COL_GREEN}[SUCCESS] $*${COL_RESET}"
+}

.travis/release.sh

@@ -1,24 +1,38 @@
 #!/bin/bash
 set -e
 
+source .travis/logger.sh
+
 echo "BUILD: $BUILD"
+RELEASE_VERSION=$(./mvnw -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec | tail -1)
+echo "RELEASE_VERSION: $RELEASE_VERSION"
 
 if [ "${BUILD}" = "deploy" ]; then
 
-RELEASE_VERSION=$(./mvnw -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec | tail -1)
-
 # Deploy to ossrh has already been done with the usual build. See build-deploy.sh
 
-# The site has been built before, the files have already been uploaded to sourceforge.
-# Since this is a release, making the binary the new default file...
-curl -H "Accept: application/json" -X PUT -d "default=windows&default=mac&default=linux&default=bsd&default=solaris&default=others" \
-     -d "api_key=${PMD_SF_APIKEY}" https://sourceforge.net/projects/pmd/files/pmd/${RELEASE_VERSION}/pmd-bin-${RELEASE_VERSION}.zip
+(
+    # disable fast fail, exit immediately, in this subshell
+    set +e
+
+    # The site has been built before, the files have already been uploaded to sourceforge.
+    # Since this is a release, making the binary the new default file...
+    log_info "Selecting pmd-bin-${RELEASE_VERSION} as default on sourceforge.net..."
+    curl -H "Accept: application/json" -X PUT -d "default=windows&default=mac&default=linux&default=bsd&default=solaris&default=others" \
+         -d "api_key=${PMD_SF_APIKEY}" https://sourceforge.net/projects/pmd/files/pmd/${RELEASE_VERSION}/pmd-bin-${RELEASE_VERSION}.zip
+    if [ $? -ne 0 ]; then
+        log_error "Couldn't select latest binary as default on sourceforge.net"
+    else
+        log_info "pmd-bin-${RELEASE_VERSION} is now the default download option."
+    fi
+    true
+)
 
 
 # Assumes, the release has already been created by travis github releases provider
 RELEASE_ID=$(curl -s -H "Authorization: token ${GITHUB_OAUTH_TOKEN}" https://api.github.com/repos/pmd/pmd/releases/tags/pmd_releases/${RELEASE_VERSION}|jq ".id")
 RELEASE_NAME="PMD ${RELEASE_VERSION} ($(date -u +%d-%B-%Y))"
-RELEASE_BODY=$(tail -n +3 src/site/markdown/overview/changelog.md) # skips the first 2 lines - the heading 'PMD Release Notes'
+RELEASE_BODY=$(tail -n +6 docs/pages/release_notes.md) # skips the first 6 lines - the heading 'PMD Release Notes'
 RELEASE_BODY="${RELEASE_BODY//'\'/\\\\}"
 RELEASE_BODY="${RELEASE_BODY//$'\r'/}"
 RELEASE_BODY="${RELEASE_BODY//$'\n'/\\r\\n}"
@@ -29,7 +43,7 @@ cat > release-edit-request.json <<EOF
   "body": "$RELEASE_BODY"
 }
 EOF
-echo "Updating release at https://api.github.com/repos/pmd/pmd/releases/${RELEASE_ID}..."
+log_info "Updating release at https://api.github.com/repos/pmd/pmd/releases/${RELEASE_ID}..."
 
 
 RESPONSE=$(curl -i -s -H "Authorization: token ${GITHUB_OAUTH_TOKEN}" -H "Content-Type: application/json" --data "@release-edit-request.json" -X PATCH https://api.github.com/repos/pmd/pmd/releases/${RELEASE_ID})
@@ -46,30 +60,58 @@ fi
 fi
 
 
-if [ "${BUILD}" = "site" ]; then
+if [ "${BUILD}" = "doc" ]; then
 
-echo "Adding the site to pmd.github.io..."
+echo -e "\n\n"
+log_info "Adding the new doc to pmd.github.io..."
 # clone pmd.github.io. Note: This uses the ssh key setup earlier
 # In order to speed things up, we use a sparse checkout - no need to checkout all directories here
 mkdir pmd.github.io
 (
     cd pmd.github.io
     git init
-    git config user.email "adangel+pmd-bot@users.sourceforge.net"
-    git config user.name "Andreas Dangel (PMD Releases)"
+    git config user.name "Travis CI (pmd-bot)"
+    git config user.email "andreas.dangel+pmd-bot@adangel.org"
     git config core.sparsecheckout true
     git remote add origin git@github.com:pmd/pmd.github.io.git
     echo "latest/" > .git/info/sparse-checkout
     git pull --depth=1 origin master
-    rsync -a ../target/pmd-doc-${RELEASE_VERSION}/ pmd-${RELEASE_VERSION}/
+    rsync -a ../docs/pmd-doc-${RELEASE_VERSION}/ pmd-${RELEASE_VERSION}/
     git add pmd-${RELEASE_VERSION}
     git commit -q -m "Added pmd-${RELEASE_VERSION}"
+
     git rm -qr latest
     cp -a pmd-${RELEASE_VERSION} latest
     git add latest
     git commit -q -m "Copying pmd-${RELEASE_VERSION} to latest"
+
+    ../.travis/sitemap_generator.sh > sitemap.xml
+    git add sitemap.xml
+    git commit -q -m "Generated sitemap.xml"
     git push origin master
 )
 
+
+
+(
+    echo -e "\n\n"
+
+    # disable fast fail, exit immediately, in this subshell
+    set +e
+
+    log_info "Uploading the new release to pmd.sourceforge.net which serves as an archive..."
+
+    travis_wait rsync -ah --stats pmd-doc-${VERSION}/ ${PMD_SF_USER}@web.sourceforge.net:/home/project-web/pmd/htdocs/pmd-${RELEASE_VERSION}/
+
+    if [ $? -ne 0 ]; then
+        log_error "Uploading documentation to pmd.sourceforge.net failed..."
+        log_error "Please upload manually (PMD Version: ${RELEASE_VERSION})"
+    else
+        log_success "The documentation is now available under http://pmd.sourceforge.net/pmd-${RELEASE_VERSION}/"
+    fi
+    true
+)
+
+
 fi
 

.travis/setup-secrets.sh

@@ -1,13 +1,18 @@
 #!/bin/bash
 set -e
 
-if [ "$TRAVIS_PULL_REQUEST" != "false" ] || [ "${TRAVIS_SECURE_ENV_VARS}" != "true" ]; then
-    echo "Not setting up secrets (TRAVIS_PULL_REQUEST=${TRAVIS_PULL_REQUEST} TRAVIS_SECURE_ENV_VARS=${TRAVIS_SECURE_ENV_VARS})."
+if [ "${TRAVIS_REPO_SLUG}" != "pmd/pmd" ] || [ "${TRAVIS_PULL_REQUEST}" != "false" ] || [ "${TRAVIS_SECURE_ENV_VARS}" != "true" ] || [ "${encrypted_5630fbebf057_iv}" = "" ]; then
+    echo "Not setting up secrets:"
+    echo "  TRAVIS_REPO_SLUG=${TRAVIS_REPO_SLUG}"
+    echo "  TRAVIS_PULL_REQUEST=${TRAVIS_PULL_REQUEST}"
+    echo "  TRAVIS_SECURE_ENV_VARS=${TRAVIS_SECURE_ENV_VARS}"
+    [ "${encrypted_5630fbebf057_iv}" = "" ] && echo "  Variable encrypted_5630fbebf057_iv is not set"
     exit 0
 fi
 
+echo "Setting up secrets..."
 
-openssl aes-256-cbc -K $encrypted_5630fbebf057_key -iv $encrypted_5630fbebf057_iv -in .travis/secrets.tar.enc -out .travis/secrets.tar -d
+openssl aes-256-cbc -K ${encrypted_5630fbebf057_key} -iv ${encrypted_5630fbebf057_iv} -in .travis/secrets.tar.enc -out .travis/secrets.tar -d
 pushd .travis && tar xfv secrets.tar && popd
 mkdir -p "$HOME/.ssh"
 chmod 700 "$HOME/.ssh"

.travis/sitemap_generator.sh

@@ -0,0 +1,56 @@
+#!/bin/bash
+
+# Sitemap generator
+# Assumes we have the latest version of the site under "latest" and "pmd-${RELEASE_VERSION}"
+# https://www.sitemaps.org/protocol.html
+
+WEBSITE_PREFIX="https://pmd.github.io/"
+DOC_PREFIX="latest/" # "pmd-${RELEASE_VERSION}/"
+DATE=`date +%Y-%m-%d`
+# Priority is relative to the website, can be chosen in {0.1, 0.2, ..., 1}
+# Default priority is 0.5
+LATEST_PRIORITY=0.8
+
+
+# Writes to standard output
+
+cat << HEADER_END
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+
+    <url>
+        <loc>${WEBSITE_PREFIX}index.html</loc>
+        <priority>1</priority>
+        <changefreq>monthly</changefreq>
+        <lastmod>$DATE</lastmod>
+    </url>
+
+    <url>
+        <loc>${WEBSITE_PREFIX}${DOC_PREFIX}index.html</loc>
+        <priority>0.9</priority>
+        <changefreq>monthly</changefreq>
+        <lastmod>$DATE</lastmod>
+    </url>
+
+
+
+HEADER_END
+
+
+for page in ${DOC_PREFIX}pmd_*.html
+do
+
+    cat << ENTRY_END
+    <url>
+        <loc>${WEBSITE_PREFIX}$page</loc>
+        <priority>$LATEST_PRIORITY</priority>
+        <changefreq>monthly</changefreq>
+        <lastmod>$DATE</lastmod>
+    </url>
+
+ENTRY_END
+
+done
+
+echo "</urlset>"
+

.travis/travis-toolchains.xml

@@ -1,34 +0,0 @@
-<?xml version="1.0" encoding="UTF8"?>
-<toolchains>
-  <!-- place this file in ${user.home}/.m2/toolchains.xml -->
-
-  <!-- see: https://github.com/travis-ci/travis-cookbooks/blob/master/cookbooks/travis_java/templates/ubuntu/jdk_switcher.sh.erb -->
-
-  <toolchain>
-    <type>jdk</type>
-    <provides>
-      <version>1.6</version>
-    </provides>
-    <configuration>
-      <jdkHome>/usr/lib/jvm/java-6-openjdk-amd64</jdkHome>
-    </configuration>
-  </toolchain>
-  <toolchain>
-    <type>jdk</type>
-    <provides>
-      <version>1.7</version>
-    </provides>
-    <configuration>
-      <jdkHome>/usr/lib/jvm/java-7-openjdk-amd64</jdkHome>
-    </configuration>
-  </toolchain>
-  <toolchain>
-    <type>jdk</type>
-    <provides>
-      <version>1.8</version>
-    </provides>
-    <configuration>
-      <jdkHome>/usr/lib/jvm/java-8-oracle</jdkHome>
-    </configuration>
-  </toolchain>
-</toolchains>

BUILDING.md

@@ -1,11 +1,7 @@
 # How to build PMD
 
-PMD uses [Maven](https://maven.apache.org/).
-
-You'll need to have a `~/.m2/toolchains.xml` file setup
-with jdk 1.7 and jdk 1.8 (for some features in pmd).
-See [maven toolchains](https://maven.apache.org/guides/mini/guide-using-toolchains.html).
-A example file can be found here: [example-toolchains.xml](https://github.com/pmd/pmd/blob/master/example-toolchains.xml).
+PMD uses [Maven](https://maven.apache.org/) and requires [Java 9](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
+for building.
 
 PMD uses the [maven wrapper](https://github.com/takari/maven-wrapper), so you can simply build PMD as following:
 
@@ -19,11 +15,14 @@ This will create the zip files in the directory `pmd-dist/target`:
 
 That's all !
 
-## How to build the documentation (maven site)?
+**Note:** While Java 9 is required for building, running PMD only requires Java 7 (or Java 8 for Apex).
 
-Building the maven site is done with the following commands:
+## How to build the documentation?
 
-    ./mvnw clean install -DskipTests=true
-    ./mvnw install site site:stage -Psite
+    cd docs
+    bundle install # once
+    bundle exec jekyll build
 
-You'll find the built site in the directory `target/staging/`.
+You'll find the built site in the directory `_site/`.
+
+For more info, see [README in docs directory](docs/README.md).

CONTRIBUTING.md

@@ -29,10 +29,11 @@ When filing a bug report, please provide as much information as possible, so tha
 
 ## Documentation
 
-There is some documentation available under <https://pmd.github.io>. Feel free to create a bug report if
-documentation is missing, incomplete or outdated.
+There is some documentation available under <https://pmd.github.io/pmd>. Feel free to create a bug report if
+documentation is missing, incomplete or outdated. See [Bug reports](#bug-reports).
 
-The documentation is generated as a maven site, the source is available at: <https://github.com/pmd/pmd/tree/master/src/site>
+The documentation is generated as a Jekyll site, the source is available at: <https://github.com/pmd/pmd/tree/master/docs>. You can find build instructions there.
+For more on contributing documentation check <https://pmd.github.io/pmd/pmd_devdocs_writing_documentation.html>
 
 ## Questions
 

README.md

@@ -1,12 +1,14 @@
 # PMD
 
+[![Join the chat at https://gitter.im/pmd/pmd](https://badges.gitter.im/pmd/pmd.svg)](https://gitter.im/pmd/pmd?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Build Status](https://travis-ci.org/pmd/pmd.svg?branch=master)](https://travis-ci.org/pmd/pmd)
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/net.sourceforge.pmd/pmd/badge.svg)](https://maven-badges.herokuapp.com/maven-central/net.sourceforge.pmd/pmd)
+[![Coverage Status](https://coveralls.io/repos/github/pmd/pmd/badge.svg)](https://coveralls.io/github/pmd/pmd)
 
 ## About
 
 **PMD** is a source code analyzer. It finds common programming flaws like unused variables, empty catch blocks,
-unnecessary object creation, and so forth. It supports Java, JavaScript, Salesforce.com Apex, PLSQL, Apache Velocity,
+unnecessary object creation, and so forth. It supports Java, JavaScript, Salesforce.com Apex and Visualforce, PLSQL, Apache Velocity,
 XML, XSL.
 
 Additionally it includes **CPD**, the copy-paste-detector. CPD finds duplicated code in

do-release.sh

@@ -24,7 +24,7 @@ echo "Releasing PMD"
 echo "-------------------------------------------"
 
 # see also https://gist.github.com/pdunnavant/4743895
-CURRENT_VERSION=$(./mvnw -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec|tail -1)
+CURRENT_VERSION=$(./mvnw -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec)
 RELEASE_VERSION=${CURRENT_VERSION%-SNAPSHOT}
 MAJOR=$(echo $RELEASE_VERSION | cut -d . -f 1)
 MINOR=$(echo $RELEASE_VERSION | cut -d . -f 2)
@@ -40,6 +40,12 @@ fi
 DEVELOPMENT_VERSION="$MAJOR.$NEXT_MINOR.$NEXT_PATCH"
 DEVELOPMENT_VERSION="${DEVELOPMENT_VERSION}-SNAPSHOT"
 
+# allow to override the next version, e.g. via "NEXT_VERSION=7.0.0 ./do-release.sh"
+if [ "$NEXT_VERSION" != "" ]; then
+    DEVELOPMENT_VERSION="${NEXT_VERSION}-SNAPSHOT"
+fi
+
+
 # http://stackoverflow.com/questions/1593051/how-to-programmatically-determine-the-current-checked-out-git-branch
 CURRENT_BRANCH=$(git symbolic-ref -q HEAD)
 CURRENT_BRANCH=${CURRENT_BRANCH##refs/heads/}
@@ -60,22 +66,35 @@ export RELEASE_VERSION
 export DEVELOPMENT_VERSION
 export CURRENT_BRANCH
 
-echo "*   Update version/release info in **src/site/markdown/overview/changelog.md**."
+RELEASE_RULESET="pmd-core/src/main/resources/rulesets/releases/${RELEASE_VERSION//\./}.xml"
+
+echo "*   Update version/release info in **docs/pages/release_notes.md**."
 echo
 echo "    ## $(date -u +%d-%B-%Y) - ${RELEASE_VERSION}"
 echo
-echo "*   Ensure all the new rules are listed in a the proper file:"
-echo "    pmd-core/src/main/resources/rulesets/releases/${RELEASE_VERSION}.xml file."
+echo "*   Update date info in **docs/_config.yml**."
 echo
-echo "*   Update **../pmd.github.io/index.html** to mention the new release"
+echo "*   Ensure all the new rules are listed in a the proper file:"
+echo "    ${RELEASE_RULESET}"
+echo
+echo "*   Update **../pmd.github.io/_config.yml** to mention the new release"
+echo
+echo "*   Add **../pmd.github.io/_posts/$(date -u +%Y-%m-%d)-PMD-${RELEASE_VERSION}.md"
 echo
 echo "Press enter to continue..."
 read
 echo "Committing current changes (pmd)"
+
+if [[ -e ${RELEASE_RULESET} ]]
+then
+    git add ${RELEASE_RULESET}
+fi
+
 git commit -a -m "Prepare pmd release ${RELEASE_VERSION}"
 (
     echo "Committing current changes (pmd.github.io)"
     cd ../pmd.github.io
+    git add _posts/$(date -u +%Y-%m-%d)-PMD-${RELEASE_VERSION}.md
     git commit -a -m "Prepare pmd release ${RELEASE_VERSION}"
     git push
 )
@@ -96,41 +115,57 @@ echo
 cat <<EOF
 PMD ${RELEASE_VERSION} released
 
-* minor version with lots of bug fixes
-* Changelog: https://pmd.github.io/pmd-${RELEASE_VERSION}/overview/changelog.html
 * Downloads: https://github.com/pmd/pmd/releases/tag/pmd_releases%2F${RELEASE_VERSION}
-* Fixed Bugs: https://sourceforge.net/p/pmd/bugs/milestone/PMD-${RELEASE_VERSION}/
 * Documentation: https://pmd.github.io/pmd-${RELEASE_VERSION}/
+
+And Copy-Paste the release notes
 EOF
 echo
 echo "Press enter to continue..."
 read
 
 echo
-echo "Check the milestone on sourceforge:"
-echo "<https://sourceforge.net/p/pmd/bugs/milestones>"
-echo
+echo "Check the milestone on github:"
+echo "<https://github.com/pmd/pmd/milestones>"
+echo " --> move any open issues to the next milestone, close the current milestone"
+echo " --> Maybe there are some milestones on sourceforge, too: <https://sourceforge.net/p/pmd/bugs/milestones>."
 echo
 echo
 echo "Prepare Next development version:"
-echo "*   Move version/release info from **src/site/markdown/overview/changelog.md** to **src/site/markdown/overview/changelog-old.md**."
-echo "*   Update version/release info in **src/site/markdown/overview/changelog.md**."
+echo "*   Update version/date info in **docs/_config.yml**."
 echo
-cat <<EOF
-# PMD Release Notes
+echo
+echo "Press enter to continue..."
+read
+
+# update release_notes_old
+OLD_RELEASE_NOTES=$(tail -n +8 docs/pages/release_notes_old.md)
+NEW_RELEASE_NOTES=$(tail -n +6 docs/pages/release_notes.md)
+echo "$(head -n 7 docs/pages/release_notes_old.md)" > docs/pages/release_notes_old.md
+echo "$NEW_RELEASE_NOTES" >> docs/pages/release_notes_old.md
+echo >> docs/pages/release_notes_old.md
+echo "$OLD_RELEASE_NOTES" >> docs/pages/release_notes_old.md
+
+# reset release notes template
+cat > docs/pages/release_notes.md <<EOF
+---
+title: PMD Release Notes
+permalink: pmd_release_notes.html
+keywords: changelog, release notes
+---
 
 ## ????? - ${DEVELOPMENT_VERSION}
 
 The PMD team is pleased to announce PMD ${DEVELOPMENT_VERSION%-SNAPSHOT}.
 
-This is a bug fixing release.
+This is a minor release.
 
 ### Table Of Contents
 
-* [New and noteworthy](#New_and_noteworthy)
-* [Fixed Issues](#Fixed_Issues)
-* [API Changes](#API_Changes)
-* [External Contributions](#External_Contributions)
+* [New and noteworthy](#new-and-noteworthy)
+* [Fixed Issues](#fixed-issues)
+* [API Changes](#api-changes)
+* [External Contributions](#external-contributions)
 
 ### New and noteworthy
 
@@ -141,11 +176,10 @@ This is a bug fixing release.
 ### External Contributions
 
 EOF
-echo
-echo "Press enter to continue..."
-read
+
 git commit -a -m "Prepare next development version"
 git push origin ${CURRENT_BRANCH}
+./mvwn -B release:clean
 echo
 echo
 echo
@@ -155,7 +189,12 @@ echo
 echo "Send out an announcement mail to the mailing list:"
 echo "To: PMD Developers List <pmd-devel@lists.sourceforge.net>"
 echo "Subject: [ANNOUNCE] PMD ${RELEASE_VERSION} Released"
-echo "Body: !!Copy Changelog!!"
+echo
+echo "    *   Downloads: https://github.com/pmd/pmd/releases/tag/pmd_releases%2F${RELEASE_VERSION}"
+echo "    *   Documentation: https://pmd.github.io/pmd-${RELEASE_VERSION}/"
+echo
+echo "    And Copy-Paste the release notes"
+echo
 echo
 echo
 echo "------------------------------------------"

docs/.gitignore

@@ -0,0 +1,5 @@
+_site/
+.sass-cache/
+.jekyll-metadata
+_pdf
+.idea/

docs/404.md

@@ -0,0 +1,8 @@
+---
+title: "Page Not Found"
+search: exclude
+---  
+
+Sorry, but the page you were trying to view does not exist. Check the URL for correctness, or try using keyword search using our search bar.
+
+[Back to the index](index.html)

docs/Dockerfile

@@ -0,0 +1,26 @@
+FROM ruby:2.4.2
+MAINTAINER mrafayaleem@gmail.com
+
+RUN apt-get clean \
+  && mv /var/lib/apt/lists /var/lib/apt/lists.broke \
+  && mkdir -p /var/lib/apt/lists/partial
+
+RUN apt-get update
+
+RUN apt-get install -y \
+    node \
+    python-pygments \
+  && apt-get clean \
+  && rm -rf /var/lib/apt/lists/
+
+WORKDIR /tmp
+ADD Gemfile /tmp/
+ADD Gemfile.lock /tmp/
+RUN bundle install
+
+VOLUME /src
+EXPOSE 4000
+
+WORKDIR /src
+ENTRYPOINT ["jekyll"]
+

docs/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'jekyll'
+gem 'github-pages'

docs/Gemfile.lock

@@ -0,0 +1,250 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.10)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.11.1)
+    colorator (1.1.0)
+    commonmarker (0.17.9)
+      ruby-enum (~> 0.5)
+    concurrent-ruby (1.0.5)
+    dnsruby (1.60.2)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    eventmachine (1.2.7)
+    execjs (2.7.0)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.23)
+    forwardable-extended (2.6.0)
+    gemoji (3.0.0)
+    github-pages (186)
+      activesupport (= 4.2.10)
+      github-pages-health-check (= 1.8.1)
+      jekyll (= 3.7.3)
+      jekyll-avatar (= 0.5.0)
+      jekyll-coffeescript (= 1.1.1)
+      jekyll-commonmark-ghpages (= 0.1.5)
+      jekyll-default-layout (= 0.1.4)
+      jekyll-feed (= 0.9.3)
+      jekyll-gist (= 1.5.0)
+      jekyll-github-metadata (= 2.9.4)
+      jekyll-mentions (= 1.3.0)
+      jekyll-optional-front-matter (= 0.3.0)
+      jekyll-paginate (= 1.1.0)
+      jekyll-readme-index (= 0.2.0)
+      jekyll-redirect-from (= 0.13.0)
+      jekyll-relative-links (= 0.5.3)
+      jekyll-remote-theme (= 0.3.1)
+      jekyll-sass-converter (= 1.5.2)
+      jekyll-seo-tag (= 2.4.0)
+      jekyll-sitemap (= 1.2.0)
+      jekyll-swiss (= 0.4.0)
+      jekyll-theme-architect (= 0.1.1)
+      jekyll-theme-cayman (= 0.1.1)
+      jekyll-theme-dinky (= 0.1.1)
+      jekyll-theme-hacker (= 0.1.1)
+      jekyll-theme-leap-day (= 0.1.1)
+      jekyll-theme-merlot (= 0.1.1)
+      jekyll-theme-midnight (= 0.1.1)
+      jekyll-theme-minimal (= 0.1.1)
+      jekyll-theme-modernist (= 0.1.1)
+      jekyll-theme-primer (= 0.5.3)
+      jekyll-theme-slate (= 0.1.1)
+      jekyll-theme-tactile (= 0.1.1)
+      jekyll-theme-time-machine (= 0.1.1)
+      jekyll-titles-from-headings (= 0.5.1)
+      jemoji (= 0.9.0)
+      kramdown (= 1.16.2)
+      liquid (= 4.0.0)
+      listen (= 3.1.5)
+      mercenary (~> 0.3)
+      minima (= 2.4.1)
+      nokogiri (>= 1.8.2, < 2.0)
+      rouge (= 2.2.1)
+      terminal-table (~> 1.4)
+    github-pages-health-check (1.8.1)
+      addressable (~> 2.3)
+      dnsruby (~> 1.60)
+      octokit (~> 4.0)
+      public_suffix (~> 2.0)
+      typhoeus (~> 1.3)
+    html-pipeline (2.8.0)
+      activesupport (>= 2)
+      nokogiri (>= 1.4)
+    http_parser.rb (0.6.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.7.3)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
+      safe_yaml (~> 1.0)
+    jekyll-avatar (0.5.0)
+      jekyll (~> 3.0)
+    jekyll-coffeescript (1.1.1)
+      coffee-script (~> 2.2)
+      coffee-script-source (~> 1.11.1)
+    jekyll-commonmark (1.2.0)
+      commonmarker (~> 0.14)
+      jekyll (>= 3.0, < 4.0)
+    jekyll-commonmark-ghpages (0.1.5)
+      commonmarker (~> 0.17.6)
+      jekyll-commonmark (~> 1)
+      rouge (~> 2)
+    jekyll-default-layout (0.1.4)
+      jekyll (~> 3.0)
+    jekyll-feed (0.9.3)
+      jekyll (~> 3.3)
+    jekyll-gist (1.5.0)
+      octokit (~> 4.2)
+    jekyll-github-metadata (2.9.4)
+      jekyll (~> 3.1)
+      octokit (~> 4.0, != 4.4.0)
+    jekyll-mentions (1.3.0)
+      activesupport (~> 4.0)
+      html-pipeline (~> 2.3)
+      jekyll (~> 3.0)
+    jekyll-optional-front-matter (0.3.0)
+      jekyll (~> 3.0)
+    jekyll-paginate (1.1.0)
+    jekyll-readme-index (0.2.0)
+      jekyll (~> 3.0)
+    jekyll-redirect-from (0.13.0)
+      jekyll (~> 3.3)
+    jekyll-relative-links (0.5.3)
+      jekyll (~> 3.3)
+    jekyll-remote-theme (0.3.1)
+      jekyll (~> 3.5)
+      rubyzip (>= 1.2.1, < 3.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-seo-tag (2.4.0)
+      jekyll (~> 3.3)
+    jekyll-sitemap (1.2.0)
+      jekyll (~> 3.3)
+    jekyll-swiss (0.4.0)
+    jekyll-theme-architect (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-cayman (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-dinky (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-hacker (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-leap-day (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-merlot (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-midnight (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-minimal (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-modernist (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-primer (0.5.3)
+      jekyll (~> 3.5)
+      jekyll-github-metadata (~> 2.9)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-slate (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-tactile (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-time-machine (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-titles-from-headings (0.5.1)
+      jekyll (~> 3.3)
+    jekyll-watch (2.0.0)
+      listen (~> 3.0)
+    jemoji (0.9.0)
+      activesupport (~> 4.0, >= 4.2.9)
+      gemoji (~> 3.0)
+      html-pipeline (~> 2.2)
+      jekyll (~> 3.0)
+    kramdown (1.16.2)
+    liquid (4.0.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    mercenary (0.3.6)
+    mini_portile2 (2.3.0)
+    minima (2.4.1)
+      jekyll (~> 3.5)
+      jekyll-feed (~> 0.9)
+      jekyll-seo-tag (~> 2.1)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    octokit (4.9.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    pathutil (0.16.1)
+      forwardable-extended (~> 2.6)
+    public_suffix (2.0.5)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rouge (2.2.1)
+    ruby-enum (0.7.2)
+      i18n
+    ruby_dep (1.5.0)
+    rubyzip (1.2.1)
+    safe_yaml (1.0.4)
+    sass (3.5.6)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thread_safe (0.3.6)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  github-pages
+  jekyll
+
+BUNDLED WITH
+   1.16.2

docs/README.md

@@ -0,0 +1,22 @@
+# PMD-New-Site
+New Site For PMD Core Open Source Project
+
+## Site Theme
+
+This site was built using the tomjohnson1492/documentation-theme-jekyll theme
+
+A Jekyll-based theme designed for documentation and help systems. See the link for detailed instructions on setting up and configuring everything. http://idratherbewriting.com/documentation-theme-jekyll/
+
+## Building using Bundler
+
+    bundle install # once
+    bundle exec jekyll serve
+
+Go to: http://localhost:4005/
+
+## Building using Docker
+
+    docker build --no-cache -t pmd-doc . # once
+    docker run --rm=true -v "$PWD:/src" -p 4005:4005 pmd-doc serve -H 0.0.0.0
+
+Go to: http://localhost:4005/

docs/_config.yml

@@ -0,0 +1,107 @@
+repository: pmd/pmd
+
+pmd:
+    version: 6.5.0
+    date: 2018-06-26
+
+output: web
+# this property is useful for conditional filtering of content that is separate from the PDF.
+
+topnav_title: PMD Source Code Analyzer Project
+# this appears on the top navigation bar next to the home button
+
+site_title: PMD Source Code Analyzer
+# this appears in the html browser tab for the site title (seen mostly by search engines, not users)
+
+company_name: PMD Open Source Project
+# this appears in the footer
+
+github_editme_path: pmd/pmd/blob/master/docs/
+# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.
+
+disqus_shortname:
+# if you're using disqus for comments, add the shortname here. if not, leave this value blank.
+
+host: 127.0.0.1
+# the preview server used. Leave as is.
+
+port: 4005
+# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006.
+
+exclude:
+  - .idea/
+  - .gitignore
+# these are the files and directories that jekyll will exclude from the build
+
+feedback_subject_line: PMD Source Code Analyzer
+
+feedback_email:
+# used as a contact email for the Feedback link in the top navigation bar
+
+feedback_disable: true
+# if you uncomment the previous line, the Feedback link gets removed
+
+# feedback_text: "Need help?"
+# if you uncomment the previous line, it changes the Feedback text
+
+# feedback_link: "http://helpy.io/"
+# if you uncomment the previous line, it changes where the feedback link points to
+
+
+markdown: kramdown
+highlighter: rouge
+kramdown:
+  input: GFM
+  auto_ids: true
+  hard_wrap: false
+  syntax_highlighter: rouge
+  syntax_highlighter_opts:
+      css_class: 'highlight'
+# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways
+
+collections:
+  tooltips:
+    output: false
+# collections are declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output unless you change output to true
+
+defaults:
+  -
+    scope:
+      path: ""
+      type: "pages"
+    values:
+      layout: "page"
+      comments: true
+      search: true
+      sidebar: pmd_sidebar
+  -
+    scope:
+      path: ""
+      type: "tooltips"
+    values:
+      layout: "page"
+      comments: true
+      search: true
+      tooltip: true
+
+  -
+    scope:
+      path: ""
+      type: "posts"
+    values:
+      layout: "post"
+      comments: true
+      search: true
+      sidebar: pmd_sidebar
+
+# these are defaults used for the frontmatter for these file types
+
+sidebars:
+- pmd_sidebar
+
+description: "Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features."
+# the description is used in the feed.xml file
+
+# needed for sitemap.xml file only
+url: https://pmd.github.io/pmd
+baseurl: ""