[BAEL-17476] - Final edits for Add README descriptions

tblakers · Dec 15, 2019 · b339c10 · b339c10
1 parent b15d47b
commit b339c10
Show file tree

Hide file tree

Showing 13 changed files with 27 additions and 11 deletions.
diff --git a/aws/README.md b/aws/README.md
@@ -1,6 +1,6 @@
 ## AWS
 
-This module contains articles about AWS
+This module contains articles about Amazon Web Services (AWS)
 
 ### Relevant articles
 

diff --git a/core-java-modules/core-java-concurrency-advanced-2/README.md b/core-java-modules/core-java-concurrency-advanced-2/README.md
@@ -1,5 +1,3 @@
-=========
-
 ## Core Java Concurrency Advanced Examples
 
 This module contains articles about advanced topics about multithreading with core Java.

diff --git a/core-java-modules/core-java-concurrency-basic-2/README.md b/core-java-modules/core-java-concurrency-basic-2/README.md
@@ -1,10 +1,11 @@
-=========
+## Core Java Concurrency Basic
 
-## Core Java Concurrency Basic 2 Examples
+This module contains articles about basic Java concurrency
 
 ### Relevant Articles: 
 - [How to Delay Code Execution in Java](https://www.baeldung.com/java-delay-code-execution)
 - [wait and notify() Methods in Java](https://www.baeldung.com/java-wait-notify)
 - [Difference Between Wait and Sleep in Java](https://www.baeldung.com/java-wait-and-sleep)
 - [Guide to the Synchronized Keyword in Java](https://www.baeldung.com/java-synchronized)
 - [Life Cycle of a Thread in Java](https://www.baeldung.com/java-thread-lifecycle)
+- [[<-- Prev]](/core-java-modules/core-java-concurrency-basic)
diff --git a/java-rmi/README.md b/java-rmi/README.md
@@ -1,6 +1,6 @@
 ## Java RMI
 
-This module contains articles about RMI (Remote Method Invocation) in Java.
+This module contains articles about Remote Method Invocation (RMI) in Java.
 
 ### Relevant articles
 

diff --git a/java-spi/README.md b/java-spi/README.md
@@ -1,6 +1,6 @@
 ## Java SPI
 
-This module contains articles about the SPI (Service Provider Interface) in Java.
+This module contains articles about the Service Provider Interface (SPI) in Java.
 
 ### Relevant Articles: 
 

diff --git a/persistence-modules/hibernate5-2/README.md b/persistence-modules/hibernate5-2/README.md
@@ -1,3 +1,8 @@
+## Hibernate 5
+
+This module contains articles about Hibernate 5.
+
 ### Relevant Articles:
 - [Hibernate Error “Not all named parameters have been set”](https://www.baeldung.com/hibernate-error-named-parameters-not-set)
 - [FetchMode in Spring Data JPA](https://www.baeldung.com/spring-data-jpa-fetchmode)
+- [[<-- Prev]](/hibernate5)
diff --git a/persistence-modules/hibernate5/README.md b/persistence-modules/hibernate5/README.md
@@ -38,3 +38,4 @@ This module contains articles about Hibernate 5.
 - [Hibernate Query Plan Cache](https://www.baeldung.com/hibernate-query-plan-cache)
 - [TransactionRequiredException Error](https://www.baeldung.com/jpa-transaction-required-exception)
 - [Enabling Transaction Locks in Spring Data JPA](https://www.baeldung.com/java-jpa-transaction-locks)
+- [[Next -->]](/hibernate5-2)
diff --git a/spring-all/README.md b/spring-all/README.md
@@ -1,3 +1,7 @@
+## Spring All
+
+This module contains articles about Spring
+
 ### Relevant Articles:
 
 - [The @Scheduled Annotation in Spring](https://www.baeldung.com/spring-scheduled-tasks)
diff --git a/spring-cloud/spring-cloud-kubernetes/README.md b/spring-cloud/spring-cloud-kubernetes/README.md
@@ -1,6 +1,6 @@
 ## Spring Cloud Kubernetes
 
-This moudle contains articles about Spring Cloud Kubernetes
+This module contains articles about Spring Cloud Kubernetes
 
 ### Relevant Articles:
 

diff --git a/spring-core-2/README.md b/spring-core-2/README.md
@@ -17,4 +17,4 @@ This module contains articles about core Spring functionality
 - [Using @Autowired in Abstract Classes](https://www.baeldung.com/spring-autowired-abstract-class)
 - [Guide to the Spring BeanFactory](https://www.baeldung.com/spring-beanfactory)
 - [Read HttpServletRequest Multiple Times](https://www.baeldung.com/spring-reading-httpservletrequest-multiple-times)
-- More articles: [[<-- prev]](/spring-core)
+- More articles: [[<-- prev]](/spring-core)[[next -->]](/spring-core-3)
diff --git a/spring-core-3/README.md b/spring-core-3/README.md
@@ -1,3 +1,7 @@
+## Spring Core
+
+This module contains articles about core Spring functionality
+
 ## Relevant Articles:
 
 - [Understanding getBean() in Spring](https://www.baeldung.com/spring-getbean)

diff --git a/spring-mvc-basics-2/README.md b/spring-mvc-basics-2/README.md
@@ -1,6 +1,7 @@
-=========
+## Spring MVC Basics
 
-## Spring MVC Basics with Java Configuration Example Project
+This module contains articles about the basics of Spring MVC. Articles about more specific areas of Spring MVC have
+their own module. 
 
 ### The Course
 The "REST With Spring" Classes: http://bit.ly/restwithspring
@@ -10,3 +11,4 @@ The "REST With Spring" Classes: http://bit.ly/restwithspring
 - [The Spring @Controller and @RestController Annotations](http://www.baeldung.com/spring-controller-vs-restcontroller)
 - [Model, ModelMap, and ModelView in Spring MVC](http://www.baeldung.com/spring-mvc-model-model-map-model-view)
 - [Spring Web Contexts](http://www.baeldung.com/spring-web-contexts)
+- [[<-- Prev]](/spring-mvc-basics)
diff --git a/spring-mvc-basics/README.md b/spring-mvc-basics/README.md
@@ -17,3 +17,4 @@ The "REST With Spring" Classes: http://bit.ly/restwithspring
 - [Using Spring @ResponseStatus to Set HTTP Status Code](https://www.baeldung.com/spring-response-status)
 - [Spring MVC and the @ModelAttribute Annotation](https://www.baeldung.com/spring-mvc-and-the-modelattribute-annotation)
 - [The HttpMediaTypeNotAcceptableException in Spring MVC](https://www.baeldung.com/spring-httpmediatypenotacceptable)
+- [[Next -->]](/spring-mvc-basics-2)