Reorganize readme & contributing pages. (#958)

readme.md and contributing.md will be used on awspring.io and.
awspring · Dec 10, 2023 · ba739d4 · ba739d4
1 parent fd0c45a
commit ba739d4
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 67 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,55 @@
-## How to contribute to Spring Cloud AWS
+# How to contribute to Spring Cloud AWS
 
-#### **Did you find a bug?**
+## Checking out and building
+
+To check out the project and build it from source, do the following:
+
+```
+git clone https://github.com/awspring/spring-cloud-aws.git
+cd spring-cloud-aws
+./mvnw package
+```
+
+To build and install jars into your local Maven cache:
+
+```
+./mvnw install
+```
+
+For faster builds, we recommend using [Maven Daemon](https://github.com/apache/maven-mvnd) and using following commands:
+
+Build:
+
+```
+make build
+```
+
+Clean:
+
+```
+make clean
+```
+
+Format code:
+
+```
+make format
+```
+
+## Building documentation
+
+Documentation can be built by activating the `docs` profile in the maven build.
+
+```
+make docs
+```
+
+It generates:
+
+- reference documentation in `docs/target/generated-docs/`
+- API docs in `target/site/`
+
+## **Did you find a bug?**
 
 * **Do not open up a GitHub issue if the bug is a security vulnerability
   in Spring Cloud AWS**, and instead to refer to our [security policy](https://github.com/awspring/spring-cloud-aws/blob/main/SECURITY.md).
@@ -9,13 +58,13 @@
 
 * If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/awspring/spring-cloud-aws/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, ideally with a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
 
-#### **Did you write a patch that fixes a bug?**
+### **Did you write a patch that fixes a bug?**
 
 * Open a new GitHub pull request with the patch.
 
 * Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
 
-#### **Do you intend to add a new feature or change an existing one?**
+### **Do you intend to add a new feature or change an existing one?**
 
 * Suggest your change in the [Issues](https://github.com/awspring/spring-cloud-aws/issues).
 
@@ -30,16 +79,14 @@
   * each package has to have `package-info.java` file definining nullability rules ([example](https://github.com/awspring/spring-cloud-aws/blob/main/spring-cloud-aws-core/src/main/java/io/awspring/cloud/core/package-info.java))
   * each nullable field, method parameter, method return value, if can be null, has to be annotated with `org.springframework.lang.Nullable`.
 
-#### **Do you have questions about the source code?**
+### **Do you have questions about the source code?**
 
 * Ask any question about how to use Spring Cloud AWS in the [Discussions](https://github.com/awspring/spring-cloud-aws/discussions).
 
-#### **Using Gitpod**
+### **Using Gitpod**
 
 To avoid setting up your local development environment, you can use [Gitpod](https://www.gitpod.io/) and develop directly in browser based Visual Studio Code, or [JetBrains Client via JetBrains Gateway](https://www.gitpod.io/docs/ides-and-editors/jetbrains-gateway).
 
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
-
-**Note**: The above button does not work on Privacy oriented browsers, please [click here](https://gitpod.io/#https://github.com/awspring/spring-cloud-aws/)  to open the project on gitpod.
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/awspring/spring-cloud-aws/)
 
 Thanks!
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-# 🍃 Spring Cloud AWS
+# Spring Cloud AWS
 
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/awspring/spring-cloud-aws/)
 
-Simplifies using AWS managed services in a Spring and Spring Boot applications.
+Spring Cloud AWS simplifies using AWS managed services in a Spring and Spring Boot applications.
 
 For a deep dive into the project, refer to the Spring Cloud AWS documentation:
 
@@ -22,11 +22,12 @@ Big thanks to [LocalStack](https://localstack.cloud) for providing PRO licenses
 
 This project has dependency and transitive dependencies on Spring Projects. The table below outlines the versions of Spring Cloud, Spring Boot and Spring Framework versions that are compatible with certain Spring Cloud AWS version.
 
-| Spring Cloud AWS             | Spring Cloud                                                                                                          | Spring Boot  | Spring Framework | AWS Java SDK |
-|------------------------------|-----------------------------------------------------------------------------------------------------------------------|--------------|------------------|--------------|
-| 2.3.x (maintenance mode)  	| [2020.0.x](https://github.com/spring-cloud/spring-cloud-release/wiki/Spring-Cloud-2020.0-Release-Notes) (3.0/Illford) | 2.4.x, 2.5.x | 5.3.x            | 1.x          |
-| 2.4.x (maintenance mode)  	| [2021.0.x](https://github.com/spring-cloud/spring-cloud-release/wiki/Spring-Cloud-2021.0-Release-Notes) (3.1/Jubilee) | 2.6.x, 2.7.x | 5.3.x            | 1.x          |
-| 3.0.x                        | [2022.0.x](https://github.com/spring-cloud/spring-cloud-release/wiki/Spring-Cloud-2022.0-Release-Notes) (4.0/Kilburn) | 3.0.x, 3.1.x | 6.0.x            | 2.x          |
+| Spring Cloud AWS            | Spring Cloud                                                                                                          | Spring Boot  | Spring Framework | AWS Java SDK |
+|-----------------------------|-----------------------------------------------------------------------------------------------------------------------|--------------|------------------|--------------|
+| 2.3.x (maintenance mode)  	 | [2020.0.x](https://github.com/spring-cloud/spring-cloud-release/wiki/Spring-Cloud-2020.0-Release-Notes) (3.0/Illford) | 2.4.x, 2.5.x | 5.3.x            | 1.x          |
+| 2.4.x (maintenance mode)  	 | [2021.0.x](https://github.com/spring-cloud/spring-cloud-release/wiki/Spring-Cloud-2021.0-Release-Notes) (3.1/Jubilee) | 2.6.x, 2.7.x | 5.3.x            | 1.x          |
+| 3.0.x                       | [2022.0.x](https://github.com/spring-cloud/spring-cloud-release/wiki/Spring-Cloud-2022.0-Release-Notes) (4.0/Kilburn) | 3.0.x, 3.1.x | 6.0.x            | 2.x          |
+| 3.1.x                       | [2023.0.x](https://github.com/spring-cloud/spring-cloud-release/wiki/Spring-Cloud-2023.0-Release-Notes) (4.0/Kilburn) | 3.2.x        | 6.1.x            | 2.x          |
 
 **Note**: 3.0.0-M2 is the last version compatible with Spring Boot 2.7.x and Spring Cloud 3.1. Starting from 3.0.0-M3, project has switched to Spring Boot 3.0.
 
@@ -54,56 +55,6 @@ Note, that Spring provides support for other AWS services in following projects:
 - [Spring Cloud Config Server](https://github.com/spring-cloud/spring-cloud-config) supports AWS Parameter Store and Secrets Manager
 - [Spring Integration for AWS](https://github.com/spring-projects/spring-integration-aws)
 
-
-## Checking out and building
-
-To check out the project and build it from source, do the following:
-
-```
-git clone https://github.com/awspring/spring-cloud-aws.git
-cd spring-cloud-aws
-./mvnw package
-```
-
-To build and install jars into your local Maven cache:
-
-```
-./mvnw install
-```
-
-For faster builds, we recommend using [Maven Daemon](https://github.com/apache/maven-mvnd) and using following commands:
-
-Build:
-
-```
-make build
-```
-
-Clean:
-
-```
-make clean
-```
-
-Format code:
-
-```
-make format
-```
-
-## Building documentation
-
-Documentation can be built by activating the `docs` profile in the maven build.
-
-```
-make docs
-```
-
-It generates:
-
-- reference documentation in `docs/target/generated-docs/`
-- API docs in `target/site/`
-
 ## Getting in touch
 
 - [Discussions on Github](https://github.com/awspring/spring-cloud-aws/discussions) - the best way to discuss anything Spring Cloud AWS related