Skip to content

Commit d3dcaa9

Browse files
Update readme.
Closes: #4998
1 parent f5570aa commit d3dcaa9

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.adoc

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
image:https://spring.io/badges/spring-data-mongodb/ga.svg[Spring Data MongoDB,link=https://spring.io/projects/spring-data-mongodb#quick-start] image:https://spring.io/badges/spring-data-mongodb/snapshot.svg[Spring Data MongoDB,link=https://spring.io/projects/spring-data-mongodb#quick-start]
2-
31
= Spring Data MongoDB image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-mongodb%2Fmain&subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-mongodb/] image:https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A["Revved up by Develocity", link="https://ge.spring.io/scans?search.rootProjectNames=Spring Data MongoDB"]
42

53
The primary goal of the https://spring.io/projects/spring-data[Spring Data] project is to make it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services.
64

7-
The Spring Data MongoDB project aims to provide a familiar and consistent Spring-based programming model for new datastores while retaining store-specific features and capabilities.
5+
The Spring Data project aims to provide a familiar and consistent Spring-based programming model for new datastores while retaining store-specific features and capabilities.
86
The Spring Data MongoDB project provides integration with the MongoDB document database.
97
Key functional areas of Spring Data MongoDB are a POJO centric model for interacting with a MongoDB `+Document+` and easily writing a repository style data access layer.
108

119
[[code-of-conduct]]
1210
== Code of Conduct
1311

14-
This project is governed by the https://github.com/spring-projects/.github/blob/e3cc2ff230d8f1dca06535aa6b5a4a23815861d4/CODE_OF_CONDUCT.md[Spring Code of Conduct]. By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
12+
This project is governed by the https://github.com/spring-projects/.github/blob/main/CODE_OF_CONDUCT.md[Spring Code of Conduct]. By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to spring-code-of-conduct@spring.io.
1513

1614
[[getting-started]]
1715
== Getting Started
@@ -42,10 +40,10 @@ public class MyService {
4240
4341
Person person = new Person();
4442
person.setFirstname("Oliver");
45-
person.setLastname("Gierke");
43+
person.setLastname("Drotbohm");
4644
repository.save(person);
4745
48-
List<Person> lastNameResults = repository.findByLastname("Gierke");
46+
List<Person> lastNameResults = repository.findByLastname("Drotbohm");
4947
List<Person> firstNameResults = repository.findByFirstnameLike("Oli*");
5048
}
5149
}
@@ -108,7 +106,6 @@ Having trouble with Spring Data? We’d love to help!
108106
https://docs.spring.io/spring-data/mongodb/reference/[reference documentation], and https://docs.spring.io/spring-data/mongodb/docs/current/api/[Javadocs]
109107
* Learn the Spring basics – Spring Data builds on Spring Framework, check the https://spring.io[spring.io] web-site for a wealth of reference documentation.
110108
If you are just starting out with Spring, try one of the https://spring.io/guides[guides].
111-
* If you are upgrading, check out the https://docs.spring.io/spring-data/mongodb/docs/current/changelog.txt[changelog] for "`new and noteworthy`" features.
112109
* Ask a question - we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-data[`spring-data-mongodb`].
113110
* Report bugs with Spring Data MongoDB at https://github.com/spring-projects/spring-data-mongodb/issues[github.com/spring-projects/spring-data-mongodb/issues].
114111

@@ -121,6 +118,7 @@ If you want to raise an issue, please follow the recommendations below:
121118
* Before you log a bug, please search the https://github.com/spring-projects/spring-data-mongodb/issues[issue tracker] to see if someone has already reported the problem.
122119
* If the issue does not already exist, https://github.com/spring-projects/spring-data-mongodb/issues/new[create a new issue].
123120
* Please provide as much information as possible with the issue report, we like to know the version of Spring Data that you are using, the JVM version, Stacktrace, etc.
121+
* Ideally provide a complete https://stackoverflow.com/help/minimal-reproducible-example[minimal sample] (something that we can unzip or git clone, build, and deploy) that reproduces the problem.
124122
* If you need to paste code, or include a stack trace use https://guides.github.com/features/mastering-markdown/[Markdown] code fences +++```+++.
125123

126124
[[guides]]
@@ -153,7 +151,7 @@ However, if you want to try out the latest and greatest, Spring Data MongoDB can
153151
and minimally, JDK 17 (https://www.oracle.com/java/technologies/downloads/[JDK downloads]).
154152

155153
In order to build Spring Data MongoDB, you will need to https://www.mongodb.com/try/download/community[download]
156-
and https://docs.mongodb.com/manual/installation/[install a MongoDB distribution].
154+
and https://docs.mongodb.com/manual/installation/[install a MongoDB distribution] and https://www.docker.com/products/docker-desktop/[Docker].
157155

158156
Once you have installed MongoDB, you need to start a MongoDB server. It is convenient to set an environment variable to
159157
your MongoDB installation directory (e.g. `MONGODB_HOME`).
@@ -181,7 +179,7 @@ To initialize the replica set, start a mongo client:
181179
[source,bash]
182180
----
183181
$ $MONGODB_HOME/bin/mongo
184-
MongoDB server version: 6.0.0
182+
MongoDB server version: 8.0.0
185183
...
186184
----
187185

@@ -211,8 +209,7 @@ Now you are ready to build Spring Data MongoDB. Simply enter the following `mvnw
211209

212210
If you want to build with the regular `mvn` command, you will need https://maven.apache.org/run-maven/index.html[Maven v3.8.0 or above].
213211

214-
_Also see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] if you wish to submit pull requests, and in particular, please sign
215-
the https://cla.pivotal.io/sign/spring[Contributor’s Agreement] before your first non-trivial change._
212+
Also see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] and add a _Signed-off-by_ trailer to your commits, if you wish to submit a pull request.
216213

217214
=== Building reference documentation
218215

0 commit comments

Comments
 (0)