Merge pull request #499 from JKomoroski/docs/documentation-improvements

Documentation improvements: spelling, grammar, broken links, and link upgrades

Author: xvik

dropwizard-guicey/src/doc/docs/about/compatibility.md

@@ -2,15 +2,15 @@
 
 Dropwizard | Guicey
 ----------|---------
-5.0.0 | [8.0.2](http://xvik.github.io/dropwizard-guicey/8.0.2)
-4.0.0 | [7.3.2](http://xvik.github.io/dropwizard-guicey/7.3.2)
-3.0.0 | [6.4.2](http://xvik.github.io/dropwizard-guicey/6.4.2)
-2.1.0 | [5.10.2](http://xvik.github.io/dropwizard-guicey/5.10.2)
-2.0.0 | [5.5.0](http://xvik.github.io/dropwizard-guicey/5.5.0)
-1.3.0 | [4.2.3](http://xvik.github.io/dropwizard-guicey/4.2.3)
-1.2.0 | [4.1.0](http://xvik.github.io/dropwizard-guicey/4.1.0)
-1.1.0 | [4.1.0](http://xvik.github.io/dropwizard-guicey/4.1.0)
-1.0 | [4.0.1](http://xvik.github.io/dropwizard-guicey/4.0.1)
+5.0.0 | [8.0.2](https://xvik.github.io/dropwizard-guicey/8.0.2)
+4.0.0 | [7.3.2](https://xvik.github.io/dropwizard-guicey/7.3.2)
+3.0.0 | [6.4.2](https://xvik.github.io/dropwizard-guicey/6.4.2)
+2.1.0 | [5.10.2](https://xvik.github.io/dropwizard-guicey/5.10.2)
+2.0.0 | [5.5.0](https://xvik.github.io/dropwizard-guicey/5.5.0)
+1.3.0 | [4.2.3](https://xvik.github.io/dropwizard-guicey/4.2.3)
+1.2.0 | [4.1.0](https://xvik.github.io/dropwizard-guicey/4.1.0)
+1.1.0 | [4.1.0](https://xvik.github.io/dropwizard-guicey/4.1.0)
+1.0 | [4.0.1](https://xvik.github.io/dropwizard-guicey/4.0.1)
 0.9 | [3.3.0](https://github.com/xvik/dropwizard-guicey/tree/dw-0.9)
 0.8 | [3.1.0](https://github.com/xvik/dropwizard-guicey/tree/dw-0.8)
 0.7 |  [1.1.0](https://github.com/xvik/dropwizard-guicey/tree/dw-0.7)

dropwizard-guicey/src/doc/docs/about/history.md

@@ -2,32 +2,32 @@
 
 ## Dropwizard 5.0
 
-* [dropwizard upgrade instructions](https://www.dropwizard.io/en/stable/manual/upgrade-notes/upgrade-notes-5_0_x.html)
+* [Dropwizard upgrade instructions](https://www.dropwizard.io/en/stable/manual/upgrade-notes/upgrade-notes-5_0_x.html)
 
 Java 17 required.
 
 ## Dropwizard 4.0
 
 Migration to jakarta namespace (`jakarta.inject`, `jakarta.servlet`, `jakarta.persistence` instead of `javax.*`).
 
-* [dropwizard upgrade instructions](https://www.dropwizard.io/en/release-4.0.x/manual/upgrade-notes/upgrade-notes-4_0_x.html)
+* [Dropwizard upgrade instructions](https://www.dropwizard.io/en/release-4.0.x/manual/upgrade-notes/upgrade-notes-4_0_x.html)
 
 Guice 7.0 [drops javax.* support completely](https://github.com/google/guice/wiki/Guice700), so you should either migrate
 to guice annotations (like `com.google.guice.Inject`) or use jakarta annotations (like `jakarta.inject.Inject`).
 
-If you're upgrading from dropwizard 2.1 it is recommended to perform step-by-step migration (due to many breaking changes):
+If you're upgrading from Dropwizard 2.1 it is recommended to perform step-by-step migration (due to many breaking changes):
 
-* guicey 5.9.0 - dropwizard 2.1, guice 6 (changed guicey project structure - same as in guicey 6)
-* guicey 6.1.0 - dropwizard 3, guice 6 (changed core dropwizard packaged)
-* guicey 7.0.0 - dropwizard 4, guice 7
+* Guicey 5.9.0 - Dropwizard 2.1, guice 6 (changed Guicey project structure - same as in Guicey 6)
+* Guicey 6.1.0 - Dropwizard 3, guice 6 (changed core Dropwizard packaged)
+* Guicey 7.0.0 - Dropwizard 4, guice 7
 
 There might be problems with 3rd party guice libraries still using javax annotations - they would not work as planned
 if `javax.inject` annotations used. If possible, migrate such libraries to jakarta namespace or, at least,
 use guice native annotations (so library could work with all guice versions).
 
 As the last option, there is a [gradle plugin](https://github.com/nebula-plugins/gradle-jakartaee-migration-plugin)
 for automatic conversion of project dependencies from javax to jakarta. This way, application started from gradle project
-would use repackaged dependencies with correct jakarta namespace. Application delivery would also contain 
+would use repackaged dependencies with correct jakarta namespace. Application delivery would also contain
 custom (repackaged) jars.
 
 Using this plugin, I did initial [automatic guice migration](https://github.com/xvik/guice-jakartaee), (appeared before official
@@ -37,39 +37,39 @@ repackage.
 
 ## Dropwizard 3.0
 
-Java 8 support dropped! Many core packages were changed so there might be problems with 3rd party modules. 
+Java 8 support dropped! Many core packages were changed so there might be problems with 3rd party modules.
 
-* [dropwizard upgrade instructions](https://www.dropwizard.io/en/release-4.0.x/manual/upgrade-notes/upgrade-notes-3_0_x.html)
+* [Dropwizard upgrade instructions](https://www.dropwizard.io/en/release-4.0.x/manual/upgrade-notes/upgrade-notes-3_0_x.html)
 
-* Guicey core was merged with ext modules to unify versioning. 
+* Guicey core was merged with extension modules to unify versioning.
 * Examples repository was also merged into the [main repository](https://github.com/xvik/dropwizard-guicey/tree/master/examples)
-* There is only one BOM now: `ru.vyarus.guicey:guicey-bom`. 
+* There is only one BOM now: `ru.vyarus.guicey:guicey-bom`.
 * Dropwizard-guicey POM is not a BOM anymore (removing ambiguity). POM simplified by using direct exclusions instead of relying on BOM.
 
 !!! note
-    Guicey 5.8.0 (for dropwizard 2.1) applies the same project structure as in guicey 6 (dropwizard 3) and
+    Guicey 5.8.0 (for Dropwizard 2.1) applies the same project structure as in Guicey 6 (Dropwizard 3) and
     so you can use it as the first migration step.
 
 ## Dropwizard 2.1
 
-* [dropwizard upgrade notes](https://www.dropwizard.io/en/release-4.0.x/manual/upgrade-notes/upgrade-notes-2_1_x.html)
+* [Dropwizard upgrade notes](https://www.dropwizard.io/en/release-4.0.x/manual/upgrade-notes/upgrade-notes-2_1_x.html)
 
-Since dropwizard 2.1.0 [jackson blackbird](https://github.com/FasterXML/jackson-modules-base/tree/jackson-modules-base-2.13.3/blackbird#readme)
+Since Dropwizard 2.1.0 [jackson blackbird](https://github.com/FasterXML/jackson-modules-base/tree/jackson-modules-base-2.13.3/blackbird#readme)
 [used by default](https://www.dropwizard.io/en/release-2.1.x/manual/upgrade-notes/upgrade-notes-2_1_x.html#jackson-blackbird-as-default)
 instead of [afterburner](https://github.com/FasterXML/jackson-modules-base/tree/jackson-modules-base-2.13.3/afterburner#readme).
 If you use **java 8** then apply afterburner dependency in order to switch into it:
 
-```
+```groovy
 implementation 'com.fasterxml.jackson.module:jackson-module-afterburner:2.13.3'
 ```
 
-(omit version if guicey or dropwizard if BOM used).
+(omit the version if the Guicey or Dropwizard BOM is used).
 Without it, you'll always see a nasty warning on startup (afterburner is better for java 8, but for java 9+ blackbird should be used)
 
 * [Java 8 issue discussion](https://github.com/xvik/dropwizard-guicey/discussions/226)
-* [dropwizard upgrade instructions](https://www.dropwizard.io/en/release-2.1.x/manual/upgrade-notes/upgrade-notes-2_1_x.html)
+* [Dropwizard upgrade instructions](https://www.dropwizard.io/en/release-2.1.x/manual/upgrade-notes/upgrade-notes-2_1_x.html)
 
 ## Dropwizard 2.0
 
-* [dropwizard upgrade instructions](https://www.dropwizard.io/en/release-2.0.x/manual/upgrade-notes/upgrade-notes-2_0_x.html)
-* [guicey migration guide](http://xvik.github.io/dropwizard-guicey/5.0.0/about/release-notes/#migration-guide).
+* [Dropwizard upgrade instructions](https://www.dropwizard.io/en/release-2.0.x/manual/upgrade-notes/upgrade-notes-2_0_x.html)
+* [Guicey migration guide](https://xvik.github.io/dropwizard-guicey/5.0.0/about/release-notes/#migration-guide).