Skip to content

Commit 38e4b76

Browse files
authored
Adjust project naming in docs (#444)
spring pulsar -> "Spring for Apache Pulsar"
1 parent 0273027 commit 38e4b76

File tree

9 files changed

+23
-23
lines changed

9 files changed

+23
-23
lines changed

CONTRIBUTING.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
= Contributing to Spring Pulsar
1+
= Contributing to Spring for Apache Pulsar
22

33
:github: https://github.com/spring-projects/spring-pulsar
44

5-
Spring Pulsar is released under the Apache 2.0 license. If you would like to contribute something, or want to hack on the code this document should help you get started.
5+
Spring for Apache Pulsar is released under the Apache 2.0 license. If you would like to contribute something, or want to hack on the code this document should help you get started.
66

77

88

@@ -23,7 +23,7 @@ Ideally, that would include a small sample project that reproduces the problem.
2323

2424

2525
== Reporting Security Vulnerabilities
26-
If you think you have found a security vulnerability in Spring Pulsar please *DO NOT* disclose it publicly until we've had a chance to fix it.
26+
If you think you have found a security vulnerability in Spring for Apache Pulsar please *DO NOT* disclose it publicly until we've had a chance to fix it.
2727
Please don't report security vulnerabilities using GitHub issues, instead head over to https://spring.io/security-policy and learn how to disclose them responsibly.
2828

2929

README.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
:docs: https://docs.spring.io/spring-pulsar/docs/current-SNAPSHOT/reference
33
:github: https://github.com/spring-projects/spring-pulsar
44

5-
Spring Pulsar provides a basic Spring-friendly API for developing https://pulsar.apache.org/[Apache Pulsar] applications.
5+
Spring for Apache Pulsar provides a basic Spring-friendly API for developing https://pulsar.apache.org/[Apache Pulsar] applications.
66

77
**#TIP#**: Most of the ideas in this project are borrowed from the Spring for Apache Kafka project, thus a familiarity with it would help.
88

@@ -12,32 +12,32 @@ include::spring-pulsar-docs/src/main/asciidoc/project-state.adoc[leveloffset=+1]
1212
The {docs}/html/[reference documentation] includes a {docs}/html/#quick-tourhtml[quick tour] section.
1313

1414
== Getting Help
15-
Are you having trouble with Spring Pulsar? We want to help!
15+
Are you having trouble with Spring for Apache Pulsar? We want to help!
1616

1717
* Check the {docs}/html/[reference documentation]
18-
* Learn the Spring basics -- Spring Pulsar builds on many other Spring projects; check the https://spring.io[spring.io] website for a wealth of reference documentation.
18+
* Learn the Spring basics -- Spring for Apache Pulsar builds on many other Spring projects; check the https://spring.io[spring.io] website for a wealth of reference documentation.
1919
If you are new to Spring, try one of the https://spring.io/guides[guides].
2020
// TODO (NYI): * If you are upgrading, read the {github}/wiki[release notes] for upgrade instructions and "new and noteworthy" features.
2121
* Ask a question -- we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-pulsar[`spring-pulsar`].
22-
* Report bugs with Spring Pulsar at {github}/issues[github.com/spring-projects/spring-pulsar/issues].
22+
* Report bugs with Spring for Apache Pulsar at {github}/issues[github.com/spring-projects/spring-pulsar/issues].
2323

2424

2525

2626
== Reporting Issues
27-
Spring Pulsar uses GitHub's integrated issue tracking system to record bugs and feature requests.
27+
Spring for Apache Pulsar uses GitHub's integrated issue tracking system to record bugs and feature requests.
2828
If you want to raise an issue, please follow the recommendations below:
2929

3030
* Before you log a bug, please search the {github}/issues[issue tracker] to see if someone has already reported the problem.
3131
* If the issue doesn't already exist, {github}/issues/new[create a new issue].
3232
* Please provide as much information as possible with the issue report.
33-
We like to know the Spring Pulsar version, operating system, and JVM version you're using.
33+
We like to know the Spring for Apache Pulsar version, operating system, and JVM version you're using.
3434
* If you need to paste code or include a stack trace, use Markdown +++```+++ escapes before and after your text.
3535
* If possible, try to create a test case or project that replicates the problem and attach it to the issue.
3636

3737

3838

3939
== Building from Source
40-
You don't need to build from source to use Spring Pulsar (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Pulsar can be built and published to your local Maven cache using the https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle wrapper].
40+
You don't need to build from source to use Spring for Apache Pulsar (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring for Apache Pulsar can be built and published to your local Maven cache using the https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle wrapper].
4141
You also need JDK 17.
4242

4343
[source,shell]
@@ -74,7 +74,7 @@ If you want skip tests, use the `-x test` and/or `-x integrationTest` options:
7474
----
7575

7676
== Modules
77-
There are several modules in Spring Pulsar. Here is a quick overview:
77+
There are several modules in Spring for Apache Pulsar. Here is a quick overview:
7878

7979
=== spring-pulsar
8080
The main library that provides the API to access Apache Pulsar.
@@ -95,8 +95,8 @@ Provides reference docs and handles aggregating javadocs.
9595
Provides the API to access Apache Pulsar using a Reactive client.
9696

9797
=== spring-pulsar-sample-apps
98-
Provides sample applications to illustrate Spring Pulsar functionality as well as provide ability for quick manual verification during development.
98+
Provides sample applications to illustrate Spring for Apache Pulsar functionality as well as provide ability for quick manual verification during development.
9999

100100

101101
== License
102-
Spring Pulsar is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
102+
Spring for Apache Pulsar is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].

spring-pulsar-docs/spring-pulsar-docs.gradle

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ plugins {
33
id 'org.asciidoctor.jvm.convert'
44
}
55

6-
description = 'Spring Pulsar Docs'
6+
description = 'Spring for Apache Pulsar Docs'
77

88
ext {
99
micrometerDocsVersion="1.0.0"
@@ -50,8 +50,8 @@ task aggregatedJavadoc(type: Javadoc) {
5050
options {
5151
encoding = "UTF-8"
5252
author = true
53-
docTitle = "Spring Pulsar ${project.version} API"
54-
windowTitle = "Spring Pulsar ${project.version} API"
53+
docTitle = "Spring for Apache Pulsar ${project.version} API"
54+
windowTitle = "Spring for Apache Pulsar ${project.version} API"
5555
overview = 'src/api/overview.html'
5656
memberLevel = JavadocMemberLevel.PROTECTED
5757
outputLevel = JavadocOutputLevel.QUIET

spring-pulsar-docs/src/main/asciidoc/intro.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ include::project-state.adoc[leveloffset=+1]
1111

1212
== System Requirements
1313

14-
Spring Pulsar `{spring-pulsar-version}` requires the following:
14+
Spring for Apache Pulsar `{spring-pulsar-version}` requires the following:
1515

1616
- https://www.java.com[Java 17] and is compatible up to and including Java 20
1717
- {spring-framework-docs}[Spring Framework `{spring-framework-version}`] or above

spring-pulsar-docs/src/main/asciidoc/observability.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,6 @@ The `tracing.endpoint` above expects Zipkin is running locally as described http
9191

9292
At this point, your application should record traces when you send and receive Pulsar messages. You should be able to view them in the Zipkin UI (at http://localhost:9411, when running locally).
9393

94-
TIP: You can also see the preceding configuration on the link:{github}/blob/main/spring-pulsar-sample-apps/README.adoc[Spring Pulsar Sample Apps].
94+
TIP: You can also see the preceding configuration on the link:{github}/blob/main/spring-pulsar-sample-apps/README.adoc[Spring for Apache Pulsar Sample Apps].
9595

9696
The steps are very similar to configuring any of the other supported Tracing environments.

spring-pulsar-docs/src/main/asciidoc/override-boot-dependencies.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ If you wish to use a different version of `pulsar-client-all` or `pulsar-client-
77

88
Or, to use a different Spring for Apache Pulsar version with a supported Spring Boot version, set the `spring-pulsar.version` property.
99

10-
In the following example, snapshot version of the Pulsar clients and Spring Pulsar are being used.
10+
In the following example, snapshot version of the Pulsar clients and Spring for Apache Pulsar are being used.
1111

1212
====
1313
[source, groovy, subs="+attributes", role="secondary"]

spring-pulsar-docs/src/main/asciidoc/pulsar.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,7 @@ void simpleBatchListenerWithHeaders(List<String> data,
584584

585585
In the preceding example, we consume the data as a `List<String>`.
586586
When extracting the various headers, we do so as a `List<>` as well.
587-
Spring Pulsar ensures that the headers list corresponds to the data list.
587+
Spring for Apache Pulsar ensures that the headers list corresponds to the data list.
588588

589589
You can also extract headers in the same manner when you use the batch listener and receive payloads as `List<org.apache.pulsar.client.api.Message<?>`, `org.apache.pulsar.client.api.Messages<?>`, or `org.springframework.messaging.Messsge<?>`.
590590

spring-pulsar-docs/src/main/asciidoc/schema-info/schema-info-listener.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
== Specifying Schema Information
22

3-
As indicated earlier, for Java primitives, the Spring Pulsar framework can infer the proper Schema to use on the `{listener-class}`.
4-
For non-primitive types, if the Schema is not explicitly specified on the annotation, the Spring Pulsar framework will try to build a `Schema.JSON` from the type.
3+
As indicated earlier, for Java primitives, the Spring for Apache Pulsar framework can infer the proper Schema to use on the `{listener-class}`.
4+
For non-primitive types, if the Schema is not explicitly specified on the annotation, the Spring for Apache Pulsar framework will try to build a `Schema.JSON` from the type.
55

66
IMPORTANT: Complex Schema types that are currently supported are JSON, AVRO, PROTOBUF, and KEY_VALUE w/ INLINE encoding.
77

spring-pulsar-docs/src/main/asciidoc/schema-info/schema-info-template.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
== Specifying Schema Information
22
If you use Java primitive types, the framework auto-detects the schema for you, and you need not specify any schema types for publishing the data.
3-
For non-primitive types, if the Schema is not explicitly specified when invoking send operations on the `{template-class}`, the Spring Pulsar framework will try to build a `Schema.JSON` from the type.
3+
For non-primitive types, if the Schema is not explicitly specified when invoking send operations on the `{template-class}`, the Spring for Apache Pulsar framework will try to build a `Schema.JSON` from the type.
44

55
IMPORTANT: Complex Schema types that are currently supported are JSON, AVRO, PROTOBUF, and KEY_VALUE w/ INLINE encoding.
66

0 commit comments

Comments
 (0)