Merge pull request #32 from quartz-scheduler/zemian-doc-fix

Update site to point to new Quartz Documentation #31

Author: zemian

.gitignore

@@ -1,3 +1,5 @@
 _site
 .sass-cache
 .DS_Store
+.idea
+quartz-worktree/

404.html

@@ -12,10 +12,10 @@ <h3><i class="fa fa-chain-broken"></i>  <i class="fa fa-frown-o"></i>   Sorry!</
 
       <ul>
         <li><a href="/downloads">Downloads</a></li>
-        <li><a href="/documentation">Documentation</a> (Docs for older 1.x releases, such as 1.8.5, can be found within their download distribution archive.)</li>
-        <li><a href="/about">About</a></li>
+        <li><a href="/documentation">Documentation</a></li>
+        <li><a href="/overview">About</a></li>
       </ul>
 
-      <p>Please consider letting us know about our dust :  tc-oss@softwareag.com
+      <p>Please consider letting us know about our dust :  <a ref="https://github.com/quartz-scheduler/quartz-scheduler.org-site/issues">https://github.com/quartz-scheduler/quartz-scheduler.org-site/issues</a>
     </div>
   </div>

Gemfile

@@ -17,3 +17,6 @@ gem 'jekyll-sass-converter', '1.5.2'
 
 # Generates a sitemap during Jekyll build
 gem 'jekyll-sitemap', '1.2.0'
+
+# Avoid polling for changes:
+gem 'wdm', '>= 0.1.0' if Gem.win_platform?

Gemfile.lock

@@ -18,7 +18,9 @@ GEM
     ethon (0.12.0)
       ffi (>= 1.3.0)
     eventmachine (1.2.7)
+    eventmachine (1.2.7-x64-mingw32)
     ffi (1.10.0)
+    ffi (1.10.0-x64-mingw32)
     forwardable-extended (2.6.0)
     html-proofer (3.9.2)
       activesupport (>= 4.2, < 6.0)
@@ -65,6 +67,8 @@ GEM
     minitest (5.11.3)
     nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
+    nokogiri (1.8.5-x64-mingw32)
+      mini_portile2 (~> 2.3.0)
     parallel (1.13.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
@@ -85,10 +89,12 @@ GEM
       ethon (>= 0.9.0)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    wdm (0.1.1)
     yell (2.0.7)
 
 PLATFORMS
   ruby
+  x64-mingw32
 
 DEPENDENCIES
   asciidoctor (= 1.5.8)
@@ -97,6 +103,7 @@ DEPENDENCIES
   jekyll-asciidoc (= 2.1.1)
   jekyll-sass-converter (= 1.5.2)
   jekyll-sitemap (= 1.2.0)
+  wdm (>= 0.1.0)
 
 BUNDLED WITH
-   1.17.1
+   1.16.1

README.md

@@ -1,4 +1,27 @@
-### Instructions for building/previewing
+## Linking with quartz 3 repository
+
+To generate the *full* site including Quartz docs, you need to link some Quartz directories in this repository.
+
+You should do it for every version you want to work on.
+
+```bash
+cd quartz-worktree
+git clone https://github.com/quartz-scheduler/quartz ${quartz-version}
+
+# If you are on Windows, you would want to use "cp -r" instead of "ln -s"
+ln -s ${quartz-version}/docs ../documentation/${quartz-version}
+```
+
+The `${quartz-version}` is the value set in `_config.yml` and it should be the latest
+quartz release version. If you want to build other version of quartz docs, you can
+add additional `${quartz-version}` that match to the git branch or tag. For examples: 
+
+|quartz-version |branch_or_tag |
+|---------------|--------------|
+|2.3.2-SNAPSHOT |quartz-2.3.x  |
+|2.3.1          |quartz-2.3.1  |
+
+## Instructions for building/previewing
 
 * Install Jekyll if you have not - follow instructions on the Jekyll home page (after first installing Ruby)
 [http://jekyllrb.com/](http://jekyllrb.com/)
@@ -11,15 +34,7 @@
 * Clone this repository to your local system (if you're going to contribute content, fork it first, and clone that)
 * cd into the "quartz.github.io" directory
 
-
-
 * To generate and view the site "jekyll serve -w"   ( then point your browser at http://localhost:4000" )
 * To generate the site "jekyll build"  
 
----
-
-
-### TODOS:
-
-* "About" -> "Features" page:
-  * could still use some love, but isn't so bad anymore
+NOTE: On windows, you would need to run `bundle.bat exec jekyll serve -w` instead.

_config.yml

@@ -9,9 +9,11 @@ github_username:  quartz-scheduler
 linkedin_username: terracotta
 facebook_username:  Terracotta
 
-qtz_latest_version: 2.2.1
-qtz_latest_javadoc_version: 2.2.1
+asciidoc_attributes: &asciidoc_attributes
+  quartz-version: 2.4.0-SNAPSHOT
 
+asciidoctor:
+  attributes: *asciidoc_attributes
 
 exclude:
   - README.md
@@ -22,10 +24,11 @@ exclude:
   - azure-pipelines.yml
   - get-deps.sh
   - add-analytics.sh
+  - .idea/
 
 exclude_from_watch:
   - .idea/
-  - _eh*/
+  - quartz-worktree/
 
 
 # Build settings

_includes/about_intro.html

@@ -1,6 +1,6 @@
 
 <h2>What is the Quartz Job Scheduling Library?</h2>
 
-<p>Quartz is a <a href="/overview/features.html">richly featured</a>, open source job scheduling library that can be integrated within virtually any Java application - from the smallest stand-alone application to the largest e-commerce system. Quartz can be used to create simple or complex schedules for executing tens, hundreds, or even tens-of-thousands of jobs; jobs whose tasks are defined as standard Java components that may execute virtually anything you may program them to do. The Quartz Scheduler includes many enterprise-class features, such as support for JTA transactions and clustering.</p>
+<p>Quartz is a <a href="/documentation/{{ site.asciidoc_attributes.quartz-version }}/introduction.html#features">richly featured</a>, open source job scheduling library that can be integrated within virtually any Java application - from the smallest stand-alone application to the largest e-commerce system. Quartz can be used to create simple or complex schedules for executing tens, hundreds, or even tens-of-thousands of jobs; jobs whose tasks are defined as standard Java components that may execute virtually anything you may program them to do. The Quartz Scheduler includes many enterprise-class features, such as support for JTA transactions and clustering.</p>
 
 <p>Quartz is freely usable, licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 license</a>.</p>

_includes/header.html

@@ -23,7 +23,7 @@
               <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false"><i class="fa fa-users"></i> Community <span class="caret"></span></a>
               <ul class="dropdown-menu">
                 <li class="dropdown-header">We Love Contributors</li>
-                <li><a href="/community/"><i class="fa fa-code"></i> Contributing</a></li>
+                <li><a href="/documentation/{{ site.asciidoc_attributes.quartz-version }}/community.html"><i class="fa fa-code"></i> Contributing</a></li>
                 <li role="separator" class="divider"></li>
                 <li class="dropdown-header">Forums</li>
                 <li><a href="https://groups.google.com/forum/#!forum/quartz-scheduler" target="_blank"><i class="fa fa-commenting"></i> Users' Forum</a></li>
@@ -40,7 +40,7 @@
           </ul>
           <ul class="nav navbar-nav navbar-right">
 <!--            <li id="site_mnu_events"><a href="/events"><i class="fa fa-calendar"></i> News & Events</a></li> -->
-            <li><a href="http://blog.terracotta.org"><i class="fa fa-rss-square"></i>  Blog</a></li>
+            <li><a href="/blog/"><i class="fa fa-rss-square"></i>  Blog</a></li>
           </ul>
         </div><!--/.nav-collapse -->
       </div>

_includes/home_announcement.html

@@ -1,3 +0,0 @@
-
-
-<p>Please read our <a href="/overview">overview</a> for additional quick information.</p>