Merge pull request #7895 from alessiostalla/BAEL-17506

#BAEL-17506 Add README descriptions to several modules.
This commit is contained in:
Josh Cummings 2019-10-03 23:36:50 -06:00 committed by GitHub
commit 3d0a1d0315
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 76 additions and 17 deletions

View File

@ -1,7 +1,7 @@
=========
## Core Java Concurrency Advanced Examples ## Core Java Concurrency Advanced Examples
This module contains articles about advanced concurrency in core Java.
### Relevant Articles: ### Relevant Articles:
- [Introduction to Thread Pools in Java](http://www.baeldung.com/thread-pool-java-and-guava) - [Introduction to Thread Pools in Java](http://www.baeldung.com/thread-pool-java-and-guava)
- [Guide to CountDownLatch in Java](http://www.baeldung.com/java-countdown-latch) - [Guide to CountDownLatch in Java](http://www.baeldung.com/java-countdown-latch)

View File

@ -1,4 +1,8 @@
## Relevant articles: ## Core Kotlin
This module contains articles about core Kotlin.
### Relevant articles:
- [Void Type in Kotlin](https://www.baeldung.com/kotlin-void-type) - [Void Type in Kotlin](https://www.baeldung.com/kotlin-void-type)
- [How to use Kotlin Range Expressions](https://www.baeldung.com/kotlin-ranges) - [How to use Kotlin Range Expressions](https://www.baeldung.com/kotlin-ranges)
@ -8,3 +12,4 @@
- [Split a List into Parts in Kotlin](https://www.baeldung.com/kotlin-split-list-into-parts) - [Split a List into Parts in Kotlin](https://www.baeldung.com/kotlin-split-list-into-parts)
- [String Comparison in Kotlin](https://www.baeldung.com/kotlin-string-comparison) - [String Comparison in Kotlin](https://www.baeldung.com/kotlin-string-comparison)
- [Guide to JVM Platform Annotations in Kotlin](https://www.baeldung.com/kotlin-jvm-annotations) - [Guide to JVM Platform Annotations in Kotlin](https://www.baeldung.com/kotlin-jvm-annotations)
- More articles: [[<-- prev]](/core-kotlin)

View File

@ -1,4 +1,8 @@
## Relevant articles: ## Core Kotlin I/O
This module contains articles about core Kotlin I/O.
### Relevant articles:
- [InputStream to String in Kotlin](https://www.baeldung.com/kotlin-inputstream-to-string) - [InputStream to String in Kotlin](https://www.baeldung.com/kotlin-inputstream-to-string)
- [Console I/O in Kotlin](https://www.baeldung.com/kotlin-console-io) - [Console I/O in Kotlin](https://www.baeldung.com/kotlin-console-io)

View File

@ -1,4 +1,8 @@
## Relevant articles: ## Core Kotlin
This module contains articles about core Kotlin.
### Relevant articles:
- [Introduction to the Kotlin Language](https://www.baeldung.com/kotlin) - [Introduction to the Kotlin Language](https://www.baeldung.com/kotlin)
- [Guide to the “when{}” Block in Kotlin](https://www.baeldung.com/kotlin-when) - [Guide to the “when{}” Block in Kotlin](https://www.baeldung.com/kotlin-when)
@ -56,3 +60,4 @@
- [Static Methods Behavior in Kotlin](https://www.baeldung.com/kotlin-static-methods) - [Static Methods Behavior in Kotlin](https://www.baeldung.com/kotlin-static-methods)
- [Inline Functions in Kotlin](https://www.baeldung.com/kotlin-inline-functions) - [Inline Functions in Kotlin](https://www.baeldung.com/kotlin-inline-functions)
- [Delegation Pattern in Kotlin](https://www.baeldung.com/kotlin-delegation-pattern) - [Delegation Pattern in Kotlin](https://www.baeldung.com/kotlin-delegation-pattern)
- More articles: [[next -->]](/core-kotlin-2)

View File

@ -1,2 +1,3 @@
## Jenkins
This is an aggregator modules for Jenkins-related modules. This is an aggregator modules for Jenkins-related modules.

View File

@ -1,3 +1,7 @@
## Relevant articles: ## Jenkins Plugins
This module contains articles about Jenkins plugins.
### Relevant articles:
- [Writing a Jenkins Plugin](http://www.baeldung.com/jenkins-custom-plugin) - [Writing a Jenkins Plugin](http://www.baeldung.com/jenkins-custom-plugin)

9
jhipster/README.md Normal file
View File

@ -0,0 +1,9 @@
## JHipster
This module contains articles about JHipster.
### Relevant articles:
- [JHipster with a Microservice Architecture](https://www.baeldung.com/jhipster-microservices)
- [Intro to JHipster](https://www.baeldung.com/jhipster)
- [Building a Basic UAA-Secured JHipster Microservice](https://www.baeldung.com/jhipster-uaa-secured-micro-service)

View File

@ -1,3 +1,7 @@
## Java Web Start
This module contains articles about Java Web Start.
### Relevant articles ### Relevant articles
- [A Guide to the Java Web Start](https://www.baeldung.com/java-web-start) - [A Guide to the Java Web Start](https://www.baeldung.com/java-web-start)

View File

@ -1,5 +1,13 @@
## Relevant Articles: ## Libraries
This module contains articles about various Java libraries.
These are small libraries that are relatively easy to use and do not require any separate module of their own.
The code examples related to different libraries are each in their own module.
Remember, for advanced libraries like [Jackson](/jackson) and [JUnit](/testing-modules) we already have separate modules. Please make sure to have a look at the existing modules in such cases.
### Relevant articles
- [A Guide to jBPM with Java](https://www.baeldung.com/jbpm-java) - [A Guide to jBPM with Java](https://www.baeldung.com/jbpm-java)
- [Guide to Classgraph Library](https://www.baeldung.com/classgraph) - [Guide to Classgraph Library](https://www.baeldung.com/classgraph)
- [Create a Java Command Line Program with Picocli](https://www.baeldung.com/java-picocli-create-command-line-program) - [Create a Java Command Line Program with Picocli](https://www.baeldung.com/java-picocli-create-command-line-program)
@ -10,3 +18,4 @@
- [Key Value Store with Chronicle Map](https://www.baeldung.com/java-chronicle-map) - [Key Value Store with Chronicle Map](https://www.baeldung.com/java-chronicle-map)
- [Guide to MapDB](https://www.baeldung.com/mapdb) - [Guide to MapDB](https://www.baeldung.com/mapdb)
- [A Guide to Apache Mesos](https://www.baeldung.com/apache-mesos) - [A Guide to Apache Mesos](https://www.baeldung.com/apache-mesos)
- More articles [[<-- prev]](/libraries)

View File

@ -1,3 +1,12 @@
## Libraries
This module contains articles about various Java libraries.
These are small libraries that are relatively easy to use and do not require any separate module of their own.
The code examples related to different libraries are each in their own module.
Remember, for advanced libraries like [Jackson](/jackson) and [JUnit](/testing-modules) we already have separate modules. Please make sure to have a look at the existing modules in such cases.
### Relevant articles ### Relevant articles
- [Introduction to Javatuples](https://www.baeldung.com/java-tuples) - [Introduction to Javatuples](https://www.baeldung.com/java-tuples)
@ -37,9 +46,4 @@
- [Implementing a FTP-Client in Java](https://www.baeldung.com/java-ftp-client) - [Implementing a FTP-Client in Java](https://www.baeldung.com/java-ftp-client)
- [Introduction to Functional Java](https://www.baeldung.com/java-functional-library) - [Introduction to Functional Java](https://www.baeldung.com/java-functional-library)
- [A Guide to the Reflections Library](https://www.baeldung.com/reflections-library) - [A Guide to the Reflections Library](https://www.baeldung.com/reflections-library)
- More articles [[next -->]](/libraries-2)
The libraries module contains examples related to small libraries that are relatively easy to use and does not require any separate module of its own.
The code examples related to different libraries should go in a new package.
Remember, for advanced libraries like JUnit, Jackson, etc. we already have separate modules. Please make sure to have a look at the existing modules in such cases.

View File

@ -4,4 +4,4 @@
- [Persisting Maps with Hibernate](https://www.baeldung.com/hibernate-persisting-maps) - [Persisting Maps with Hibernate](https://www.baeldung.com/hibernate-persisting-maps)
- [Difference Between @Size, @Length, and @Column(length=value)](https://www.baeldung.com/jpa-size-length-column-differences) - [Difference Between @Size, @Length, and @Column(length=value)](https://www.baeldung.com/jpa-size-length-column-differences)
- [Hibernate Validator Specific Constraints](https://www.baeldung.com/hibernate-validator-constraints) - [Hibernate Validator Specific Constraints](https://www.baeldung.com/hibernate-validator-constraints)
- [Hibernate One to Many Annotation Tutorial](http://www.baeldung.com/hibernate-one-to-many) - [Hibernate One to Many Annotation Tutorial](http://www.baeldung.com/hibernate-one-to-many)

View File

@ -1,4 +1,8 @@
## Relevant articles: ## Hibernate 5
This module contains articles about Hibernate 5.
### Relevant articles:
- [Dynamic Mapping with Hibernate](http://www.baeldung.com/hibernate-dynamic-mapping) - [Dynamic Mapping with Hibernate](http://www.baeldung.com/hibernate-dynamic-mapping)
- [An Overview of Identifiers in Hibernate](http://www.baeldung.com/hibernate-identifiers) - [An Overview of Identifiers in Hibernate](http://www.baeldung.com/hibernate-identifiers)

View File

@ -1,4 +1,8 @@
# Relevant Articles ## JPA in Java
This module contains articles about the Java Persistence API (JPA) in Java.
### Relevant Articles
- [JPA Query Parameters Usage](https://www.baeldung.com/jpa-query-parameters-usage) - [JPA Query Parameters Usage](https://www.baeldung.com/jpa-query-parameters-usage)
- [Mapping Entitiy Class Names to SQL Table Names with JPA](https://www.baeldung.com/jpa-entity-table-names) - [Mapping Entitiy Class Names to SQL Table Names with JPA](https://www.baeldung.com/jpa-entity-table-names)
@ -6,3 +10,4 @@
- [Types of JPA Queries](https://www.baeldung.com/jpa-queries) - [Types of JPA Queries](https://www.baeldung.com/jpa-queries)
- [JPA/Hibernate Projections](https://www.baeldung.com/jpa-hibernate-projections) - [JPA/Hibernate Projections](https://www.baeldung.com/jpa-hibernate-projections)
- [Combining JPA And/Or Criteria Predicates](https://www.baeldung.com/jpa-and-or-criteria-predicates) - [Combining JPA And/Or Criteria Predicates](https://www.baeldung.com/jpa-and-or-criteria-predicates)
- More articles: [[<-- prev]](/java-jpa)

View File

@ -1,4 +1,8 @@
# Relevant Articles ## JPA in Java
This module contains articles about the Java Persistence API (JPA) in Java.
### Relevant Articles
- [A Guide to SqlResultSetMapping](https://www.baeldung.com/jpa-sql-resultset-mapping) - [A Guide to SqlResultSetMapping](https://www.baeldung.com/jpa-sql-resultset-mapping)
- [A Guide to Stored Procedures with JPA](https://www.baeldung.com/jpa-stored-procedures) - [A Guide to Stored Procedures with JPA](https://www.baeldung.com/jpa-stored-procedures)
@ -10,3 +14,4 @@
- [Defining JPA Entities](https://www.baeldung.com/jpa-entities) - [Defining JPA Entities](https://www.baeldung.com/jpa-entities)
- [JPA @Basic Annotation](https://www.baeldung.com/jpa-basic-annotation) - [JPA @Basic Annotation](https://www.baeldung.com/jpa-basic-annotation)
- [Persisting Enums in JPA](https://www.baeldung.com/jpa-persisting-enums-in-jpa) - [Persisting Enums in JPA](https://www.baeldung.com/jpa-persisting-enums-in-jpa)
- More articles: [[next -->]](/java-jpa-2)