document

Author: sonus21

README.md

@@ -328,20 +328,16 @@ environment variables for Spring versions.
 
 ## Links
 
-* Documentation:
-  [https://github.com/sonus21/rqueue/wiki](https://github.com/sonus21/rqueue/wiki)
-* Releases:
-  [https://github.com/sonus21/rqueue/releases](https://github.com/sonus21/rqueue/releases)
-* Issue tracker:
-  [https://github.com/sonus21/rqueue/issues](https://github.com/sonus21/rqueue/issues)
+* Documentation: [https://sonus21.github.com/rqueue](https://sonus21.github.com/rqueue)
+* Releases: [https://github.com/sonus21/rqueue/releases](https://github.com/sonus21/rqueue/releases)
+* Issue tracker: [https://github.com/sonus21/rqueue/issues](https://github.com/sonus21/rqueue/issues)
 * Maven Central:
   * [https://repo1.maven.org/maven2/com/github/sonus21/rqueue-spring](https://repo1.maven.org/maven2/com/github/sonus21/rqueue-spring)
   * [https://repo1.maven.org/maven2/com/github/sonus21/rqueue-spring-boot-starter](https://repo1.maven.org/maven2/com/github/sonus21/rqueue-spring-boot-starter)
-
+  
 * StackOverflow: [https://stackoverflow.com/tags/rqueue](https://stackoverflow.com/tags/rqueue)
 * Discord: https://discord.gg/2hgQZXS2
-* Project
-  Progress: [https://github.com/sonus21/rqueue/projects/3](https://github.com/sonus21/rqueue/projects/3)
+* Project Progress: [https://github.com/sonus21/rqueue/projects/3](https://github.com/sonus21/rqueue/projects/3)
 
 ## License
 

docs/404.html

@@ -0,0 +1,11 @@
+---
+layout: default
+title: 404
+permalink: /404
+nav_exclude: true
+search_exclude: true
+---
+
+<h1>Page not found</h1>
+
+<p>The page you requested could not be found. Try using the navigation {% if site.search_enabled != false %}or search {% endif %}to find what you're looking for or go to this <a href="{{ '/' | relative_url }}">site's home page</a>.</p>

CHANGELOG.md renamed to docs/CHANGELOG.md

@@ -1,17 +1,29 @@
-# [Rqueue] New and Notable Changes
+---
+title: CHANGELOG
+layout: default
 
-### [3.0.1] - 17-Jan-2022
+---
+
+# CHANGELOG
+
+All notable user-facing changes to this project are documented in this file.
+
+## Release [3.0.1] 17-Jan-2022
+
+We're so excited to release Rqueue `3.0.1`. This release supports the Java 17, Spring Boot 3.x and Spring Framework 6.x
 
-* Support for spring boot 3.0
 
 ### [2.13.0] - 25-Dec-2022
 
 ### Fixes
+{: .highlight} 
+Migrate to this version as soon as possible to avoid duplicate message consumption post deletion.
 
 * Important fix for parallel message deletion or delete the message from message listener
 * No threads are available, improvement on message poller
 * Use System Zone ID for UI bottom screen
 
+
 ### [2.12.0] - 14-Dec-2022
 
 ### Fixes
@@ -21,17 +33,14 @@
 
 ### [2.11.1] - 18-Nov-2022
 
-### Fixes
-
-Bug introduced by 2.11
+{: .highlight} 
+Migrate to this version as soon as possible to avoid message build up. Messages in scheduled queue 
+can grow if poller is failing. Workaround is to restart the application. 
 
-### [2.11] - 07-Nov-2022
+* Message mover unreliability, scheduled message were not getting consumed once redis connection error occurs
+* Upgraded Jquery version
 
-### Fixes
 
-* Message mover unreliability, scheduled message were not getting consumed once redis connection
-  error occurs
-* Upgraded Jquery version
 
 ### [2.10.2] - 16-Jul-2022
 
@@ -51,6 +60,11 @@ Bug introduced by 2.11
 
 ### [2.10.0] - 10-Oct-2021
 
+{: .warning } 
+Breaking change, if you're controlling any internal settings of Rqueue using application environment
+or configuration variable than application can break. We've renamed some config keys, [see](./migration#290-to-210)
+
+
 ### Fixes
 
 * Fixes for post processor calls (post processor calls were not made)
@@ -89,7 +103,7 @@ Bug introduced by 2.11
 ### Added
 
 * Pause/Unpause queue from dashboard
-* Pause/Unpause queue programatically
+* Pause/Unpause queue programmatically
 * Batch message fetching
 * Default queue priority to WEIGHTED
 * Added an API to update the visibility timeout of running job
@@ -213,6 +227,15 @@ Fixes:
 
 ## [2.0.0] - 10-May-2020
 
+{: .warning}
+Breaking change, for migration [see](./migration#1x-to-2x)
+
+- Queue names are prefixed, that can lead to error. 1.x users set REDIS key `__rq::version` to `1`.
+  It does try to find the version using key prefix, but if all queues are empty or no key exist in
+  REDIS with prefix `rqueue-` then it will consider version 2.
+- Renamed annotation field `maxJobExecutionTime` to `visibilityTimeout`
+
+
 ### Added
 
 - Web interface to visualize queue
@@ -227,13 +250,6 @@ Fixes:
 - Multi level queue priority
 - Strict or weighted algorithm for message execution
 
-### Breaking Changes
-
-- Queue names are prefixed, that can lead to error. 1.x users set REDIS key `__rq::version` to `1`.
-  It does try to find the version using key prefix, but if all queues are empty or no key exist in
-  REDIS with prefix `rqueue-` then it will consider version 2.
-- Renamed annotation field `maxJobExecutionTime` to `visibilityTimeout`
-
 ### Fixes
 
 - **Spring** Optional Micrometer, in older version config class was importing micrometer related
@@ -278,6 +294,7 @@ Fixes:
 
 * The basic version of Asynchronous task execution using Redis for Spring and Spring Boot
 
+
 [1.0]: https://repo1.maven.org/maven2/com/github/sonus21/rqueue/1.0-RELEASE
 
 [1.1]: https://repo1.maven.org/maven2/com/github/sonus21/rqueue/1.1-RELEASE

docs/Gemfile

@@ -1,7 +1,32 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem "jekyll", "~> 4.3.2"
+gem "just-the-docs", "0.4.0"
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.12"
+  gem "jekyll-seo-tag"
+  gem "jekyll-default-layout"
+end
 
-gem "jekyll", "~> 4.3" # installed by `gem jekyll`
-# gem "webrick"        # required when using Ruby >= 3 and Jekyll <= 4.2.2
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", ">= 1", "< 3"
+  gem "tzinfo-data"
+end
 
-gem "just-the-docs", "0.4.0" # pinned to the current release
-# gem "just-the-docs"        # always download the latest release
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
+
+gem "webrick", "~> 1.7"

docs/Gemfile.loc renamed to docs/Gemfile.lock

@@ -4,17 +4,18 @@ GEM
     addressable (2.8.1)
       public_suffix (>= 2.0.2, < 6.0)
     colorator (1.1.0)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.0)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
     eventmachine (1.2.7)
     ffi (1.15.5)
     forwardable-extended (2.6.0)
+    google-protobuf (3.21.12)
     http_parser.rb (0.8.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    jekyll (4.3.0)
+    jekyll (4.3.2)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -30,8 +31,12 @@ GEM
       safe_yaml (~> 1.0)
       terminal-table (>= 1.8, < 4.0)
       webrick (~> 1.7)
-    jekyll-sass-converter (2.2.0)
-      sassc (> 2.0.1, < 3.0)
+    jekyll-default-layout (0.1.5)
+      jekyll (>= 3.0, < 5.0)
+    jekyll-feed (0.17.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-sass-converter (3.0.0)
+      sass-embedded (~> 1.54)
     jekyll-seo-tag (2.8.0)
       jekyll (>= 3.8, < 5.0)
     jekyll-watch (2.2.1)
@@ -44,36 +49,42 @@ GEM
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    liquid (4.0.3)
-    listen (3.7.1)
+    liquid (4.0.4)
+    listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.4.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (5.0.0)
+    public_suffix (5.0.1)
     rake (13.0.6)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rexml (3.2.5)
-    rouge (4.0.0)
+    rouge (4.0.1)
     safe_yaml (1.0.5)
-    sassc (2.4.0)
-      ffi (~> 1.9)
+    sass-embedded (1.58.0-arm64-darwin)
+      google-protobuf (~> 3.21)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    unicode-display_width (2.3.0)
-    webrick (1.7.0)
+    unicode-display_width (2.4.2)
+    webrick (1.8.1)
 
 PLATFORMS
   arm64-darwin-21
-  x86_64-darwin-19
-  x86_64-linux
 
 DEPENDENCIES
-  jekyll (~> 4.3)
+  http_parser.rb (~> 0.6.0)
+  jekyll (~> 4.3.2)
+  jekyll-default-layout
+  jekyll-feed (~> 0.12)
+  jekyll-seo-tag
   just-the-docs (= 0.4.0)
+  tzinfo (>= 1, < 3)
+  tzinfo-data
+  wdm (~> 0.1.1)
+  webrick (~> 1.7)
 
 BUNDLED WITH
-   2.3.9
+   2.3.11