[docs] Add simple script to build site locally

Also add more excludes for jekyll

Author: adangel

docs/.gitignore

@@ -3,3 +3,5 @@ _site/
 .jekyll-metadata
 _pdf
 .idea/
+vendor/
+.bundle/

docs/README.md

@@ -1,19 +1,33 @@
-# PMD-New-Site
-New Site For PMD Core Open Source Project
+# PMD Documentation
+
+The documentation is available at: <https://pmd.github.io/pmd/>
+
+The documentation for the latest release is at: <https://pmd.github.io/latest/>
 
 ## 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 Script
+
+    bash build-docs.sh
+
+This will run bundler to fetch and potentially update the ruby gems.
+And then it will execute jekyll and build a offline site.
+Open the file `_site/index.html` with your browser to see the site.
+
 ## Building using Bundler
 
     bundle install # once
     bundle exec jekyll serve
 
 Go to: http://localhost:4005/
 
+This variant is useful to get constant updates: When you modify a file, jekyll will automatically rebuild
+the site, so you just need to hit Refresh in the browser to see the update.
+
 ## Building using Docker
 
     docker build --no-cache -t pmd-doc . # once

docs/_config.yml

@@ -29,10 +29,16 @@ host: 127.0.0.1
 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.
 
+# these are the files and directories that jekyll will exclude from the build
 exclude:
   - .idea/
   - .gitignore
-# these are the files and directories that jekyll will exclude from the build
+  - vendor/
+  - Gemfile
+  - Gemfile.lock
+  - README.md
+  - Dockerfile
+  - build-docs.sh
 
 feedback_subject_line: PMD Source Code Analyzer
 

docs/build-docs.sh

@@ -0,0 +1,3 @@
+bundle install --path vendor/bundle
+bundle update
+bundle exec jekyll build