Skip to content

Commit 1c9f28f

Browse files
Reorganize readme & contributing pages. (#958)
readme.md and contributing.md will be used on awspring.io and.
1 parent 70c95d0 commit 1c9f28f

File tree

2 files changed

+65
-67
lines changed

2 files changed

+65
-67
lines changed

CONTRIBUTING.md

Lines changed: 56 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,55 @@
1-
## How to contribute to Spring Cloud AWS
1+
# How to contribute to Spring Cloud AWS
22

3-
#### **Did you find a bug?**
3+
## Checking out and building
4+
5+
To check out the project and build it from source, do the following:
6+
7+
```
8+
git clone https://github.com/awspring/spring-cloud-aws.git
9+
cd spring-cloud-aws
10+
./mvnw package
11+
```
12+
13+
To build and install jars into your local Maven cache:
14+
15+
```
16+
./mvnw install
17+
```
18+
19+
For faster builds, we recommend using [Maven Daemon](https://github.com/apache/maven-mvnd) and using following commands:
20+
21+
Build:
22+
23+
```
24+
make build
25+
```
26+
27+
Clean:
28+
29+
```
30+
make clean
31+
```
32+
33+
Format code:
34+
35+
```
36+
make format
37+
```
38+
39+
## Building documentation
40+
41+
Documentation can be built by activating the `docs` profile in the maven build.
42+
43+
```
44+
make docs
45+
```
46+
47+
It generates:
48+
49+
- reference documentation in `docs/target/generated-docs/`
50+
- API docs in `target/site/`
51+
52+
## **Did you find a bug?**
453

554
* **Do not open up a GitHub issue if the bug is a security vulnerability
655
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 @@
958

1059
* 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.
1160

12-
#### **Did you write a patch that fixes a bug?**
61+
### **Did you write a patch that fixes a bug?**
1362

1463
* Open a new GitHub pull request with the patch.
1564

1665
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
1766

18-
#### **Do you intend to add a new feature or change an existing one?**
67+
### **Do you intend to add a new feature or change an existing one?**
1968

2069
* Suggest your change in the [Issues](https://github.com/awspring/spring-cloud-aws/issues).
2170

@@ -30,16 +79,14 @@
3079
* 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))
3180
* each nullable field, method parameter, method return value, if can be null, has to be annotated with `org.springframework.lang.Nullable`.
3281

33-
#### **Do you have questions about the source code?**
82+
### **Do you have questions about the source code?**
3483

3584
* Ask any question about how to use Spring Cloud AWS in the [Discussions](https://github.com/awspring/spring-cloud-aws/discussions).
3685

37-
#### **Using Gitpod**
86+
### **Using Gitpod**
3887

3988
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).
4089

41-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
42-
43-
**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.
90+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/awspring/spring-cloud-aws/)
4491

4592
Thanks!

README.md

Lines changed: 9 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# 🍃 Spring Cloud AWS
1+
# Spring Cloud AWS
22

3-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
3+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/awspring/spring-cloud-aws/)
44

5-
Simplifies using AWS managed services in a Spring and Spring Boot applications.
5+
Spring Cloud AWS simplifies using AWS managed services in a Spring and Spring Boot applications.
66

77
For a deep dive into the project, refer to the Spring Cloud AWS documentation:
88

@@ -22,11 +22,12 @@ Big thanks to [LocalStack](https://localstack.cloud) for providing PRO licenses
2222

2323
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.
2424

25-
| Spring Cloud AWS | Spring Cloud | Spring Boot | Spring Framework | AWS Java SDK |
26-
|------------------------------|-----------------------------------------------------------------------------------------------------------------------|--------------|------------------|--------------|
27-
| 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 |
28-
| 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 |
29-
| 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 |
25+
| Spring Cloud AWS | Spring Cloud | Spring Boot | Spring Framework | AWS Java SDK |
26+
|-----------------------------|-----------------------------------------------------------------------------------------------------------------------|--------------|------------------|--------------|
27+
| 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 |
28+
| 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 |
29+
| 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 |
30+
| 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 |
3031

3132
**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.
3233

@@ -54,56 +55,6 @@ Note, that Spring provides support for other AWS services in following projects:
5455
- [Spring Cloud Config Server](https://github.com/spring-cloud/spring-cloud-config) supports AWS Parameter Store and Secrets Manager
5556
- [Spring Integration for AWS](https://github.com/spring-projects/spring-integration-aws)
5657

57-
58-
## Checking out and building
59-
60-
To check out the project and build it from source, do the following:
61-
62-
```
63-
git clone https://github.com/awspring/spring-cloud-aws.git
64-
cd spring-cloud-aws
65-
./mvnw package
66-
```
67-
68-
To build and install jars into your local Maven cache:
69-
70-
```
71-
./mvnw install
72-
```
73-
74-
For faster builds, we recommend using [Maven Daemon](https://github.com/apache/maven-mvnd) and using following commands:
75-
76-
Build:
77-
78-
```
79-
make build
80-
```
81-
82-
Clean:
83-
84-
```
85-
make clean
86-
```
87-
88-
Format code:
89-
90-
```
91-
make format
92-
```
93-
94-
## Building documentation
95-
96-
Documentation can be built by activating the `docs` profile in the maven build.
97-
98-
```
99-
make docs
100-
```
101-
102-
It generates:
103-
104-
- reference documentation in `docs/target/generated-docs/`
105-
- API docs in `target/site/`
106-
10758
## Getting in touch
10859

10960
- [Discussions on Github](https://github.com/awspring/spring-cloud-aws/discussions) - the best way to discuss anything Spring Cloud AWS related

0 commit comments

Comments
 (0)