Skip to content

Commit 709f558

Browse files
artembilangaryrussell
authored andcommitted
Some Docs improvements
* Add short description to content link in the `index.adoc` to make it more clear what target chapter is about * Fix `index-header.adoc` to not show a links to other doc formats. Instead, use correct link to single/multi according the current context * Add `Feedback` and `Getting Started` sections to `preface.adoc`
1 parent 9075453 commit 709f558

File tree

5 files changed

+100
-68
lines changed

5 files changed

+100
-68
lines changed

src/reference/asciidoc/core.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[[spring-integration-core-msg]]
55
This section covers all aspects of the core messaging API in Spring Integration.
66
It covers messages, message channels, and message endpoints.
7-
It also covers many of the enterprise integration patterns, such as filter, router, transformer, service activator , splitter, and aggregator.
7+
It also covers many of the enterprise integration patterns, such as filter, router, transformer, service activator, splitter, and aggregator.
88

99
This section also contains material about system management, including the control bus and message history support.
1010

src/reference/asciidoc/index-header.adoc

-10
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,6 @@
22
= Spring Integration Reference Guide
33
Mark Fisher; Marius Bogoevici; Iwein Fuld; Jonas Partner; Oleg Zhurakousky; Gary Russell; Dave Syer; Josh Long; David Turanski; Gunnar Hillert; Artem Bilan; Amol Nayak; Jay Bryant
44

5-
ifdef::backend-html5[]
6-
*{revnumber}*
7-
8-
NOTE: This documentation is also available as https://docs.spring.io/spring-integration/docs/current/reference/html/index.html[multiple (faster to load) HTML pages] and as https://docs.spring.io/spring-integration/docs/current/reference/pdf/spring-integration-reference.pdf[PDF].
9-
endif::[]
10-
11-
ifdef::backend-pdf[]
12-
NOTE: This documentation is also available as https://docs.spring.io/spring-integration/docs/current/reference/html/index.html[multiple (faster to load) HTML pages] and as a single https://docs.spring.io/spring-integration/docs/current/reference/html/index-single.html[(more easily searchable) HTML file].
13-
endif::[]
14-
155
(C) 2009 - 2022 VMware, Inc.
166
All rights reserved.
177

src/reference/asciidoc/index-single.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@
55
// BE SURE TO PRECEDE ALL include:: with a blank line - see https://github.com/asciidoctor/asciidoctor/issues/1297
66
include::./index-header.adoc[]
77

8+
ifdef::backend-html5[]
9+
*{revnumber}*
10+
11+
NOTE: This documentation is also available as https://docs.spring.io/spring-integration/docs/current/reference/html/index.html[multiple (faster to load) HTML pages] and as https://docs.spring.io/spring-integration/docs/current/reference/pdf/spring-integration-reference.pdf[PDF].
12+
endif::[]
13+
14+
ifdef::backend-pdf[]
15+
NOTE: This documentation is also available as https://docs.spring.io/spring-integration/docs/current/reference/html/index.html[multiple (faster to load) HTML pages] and as a single https://docs.spring.io/spring-integration/docs/current/reference/html/index-single.html[(more easily searchable) HTML file].
16+
endif::[]
17+
818
include::./preface.adoc[]
919

1020
include::./whats-new.adoc[]

src/reference/asciidoc/index.adoc

+66-57
Original file line numberDiff line numberDiff line change
@@ -2,73 +2,82 @@
22

33
include::./index-header.adoc[]
44

5+
ifdef::backend-html5[]
6+
*{revnumber}*
7+
8+
NOTE: This documentation is also available as single searchable link:index-single.html[html] and link:../pdf/spring-integration-reference.pdf[pdf] documents.
9+
endif::[]
10+
11+
ifdef::backend-pdf[]
12+
NOTE: This documentation is also available as https://docs.spring.io/spring-integration/docs/current/reference/html/index.html[multiple (faster to load) HTML pages] and as a single https://docs.spring.io/spring-integration/docs/current/reference/html/index-single.html[(more easily searchable) HTML file].
13+
endif::[]
14+
515
Welcome to the Spring Integration reference documentation!
6-
This documentation is also available as single searchable link:index-single.html[html] and link:../pdf/spring-integration-reference.pdf[pdf] documents.
716

817
[horizontal]
9-
<<./preface.adoc#preface,Preface>> ::
10-
<<./whats-new.adoc#whats-new,What's New>> ::
11-
<<./overview.adoc#spring-integration-introduction,Overview>> ::
12-
<<./core.adoc#spring-integration-core-messaging,Core Messaging>> ::
13-
<<./message.adoc#message,Message>> ::
14-
<<./message-routing.adoc#messaging-routing-chapter,Message Routing>> ::
15-
<<./message-transformation.adoc#messaging-transformation-chapter,Message Transformation>> ::
16-
<<./messaging-endpoints.adoc#messaging-endpoints-chapter,Messaging Endpoints>> ::
17-
<<./dsl.adoc#java-dsl,Java DSL>> ::
18-
<<./kotlin-dsl.adoc#kotlin-dsl,Kotlin DSL>> ::
19-
<<./system-management.adoc#system-management-chapter,System Management>> ::
20-
<<./reactive-streams.adoc#reactive-streams,Reactive Streams Support>> ::
18+
<<./preface.adoc#preface,Preface>> :: General project info, conventions
19+
<<./whats-new.adoc#whats-new,What's New>> :: Features and changes made in the current version
20+
<<./overview.adoc#spring-integration-introduction,Overview>> :: Introduction to EIP and its implementation in the project
21+
<<./core.adoc#spring-integration-core-messaging,Core Messaging>> :: Main project abstractions and components
22+
<<./message.adoc#message,Message>> :: Details about the message abstraction implementations
23+
<<./message-routing.adoc#messaging-routing-chapter,Message Routing>> :: main EIP components: router, splitter, aggregator, filter etc.
24+
<<./message-transformation.adoc#messaging-transformation-chapter,Message Transformation>> :: Transformer, content enricher, claim check, codec
25+
<<./messaging-endpoints.adoc#messaging-endpoints-chapter,Messaging Endpoints>> :: Consumer endpoints, service activator, gateway, scripting, AOP aspects etc.
26+
<<./dsl.adoc#java-dsl,Java DSL>> :: Details about Java DSL for EIP
27+
<<./kotlin-dsl.adoc#kotlin-dsl,Kotlin DSL>> :: Details about Kotlin DSL for EIP
28+
<<./system-management.adoc#system-management-chapter,System Management>> :: Message store, control bus, integration graph, metrics, JMX
29+
<<./reactive-streams.adoc#reactive-streams,Reactive Streams Support>> :: Details about Reactive Streams support: message channels, channel adapters etc.
2130

2231
[horizontal]
2332
**Integration Endpoints** ::
2433

2534
[horizontal]
26-
<<./endpoint-summary.adoc#spring-integration-endpoints,Integration Endpoint Summary>> ::
27-
<<./amqp.adoc#amqp,AMQP Support>> ::
28-
<<./event.adoc#applicationevent,Spring `ApplicationEvent` Support>> ::
29-
<<./feed.adoc#feed,Feed Adapter>> ::
30-
<<./file.adoc#files,File Support>> ::
31-
<<./ftp.adoc#ftp,FTP/FTPS Adapters>> ::
32-
<<./gemfire.adoc#gemfire,Pivotal GemFire and Apache Geode Support>> ::
33-
<<./graphql.adoc#graphql,GraphQL Support>> ::
34-
<<./http.adoc#http,HTTP Support>> ::
35-
<<./jdbc.adoc#jdbc,JDBC Support>> ::
36-
<<./jpa.adoc#jpa,JPA Support>> ::
37-
<<./jms.adoc#jms,JMS Support>> ::
38-
<<./jmx.adoc#jmx,JMX Support>> ::
39-
<<./kafka.adoc#kafka,Apache Kafka Support>> ::
40-
<<./mail.adoc#mail,Mail Support>> ::
41-
<<./mongodb.adoc#mongodb,MongoDb Support>> ::
42-
<<./mqtt.adoc#mqtt,MQTT Support>> ::
43-
<<./r2dbc.adoc#r2dbc,R2DBC Support>> ::
44-
<<./redis.adoc#redis,Redis Support>> ::
45-
<<./resource.adoc#resource,Resource Support>> ::
46-
<<./rsocket.adoc#rsocket,RSocket Support>> ::
47-
<<./sftp.adoc#sftp,SFTP Adapters>> ::
48-
<<./smb.adoc#smb,SMB Support>> ::
49-
<<./stomp.adoc#stomp,STOMP Support>> ::
50-
<<./stream.adoc#stream,Stream Support>> ::
51-
<<./syslog.adoc#syslog,Syslog Support>> ::
52-
<<./ip.adoc#ip,TCP and UDP Support>> ::
53-
<<./webflux.adoc#webflux,WebFlux Support>> ::
54-
<<./web-sockets.adoc#web-sockets,WebSockets Support>> ::
55-
<<./ws.adoc#ws,Web Services Support>> ::
56-
<<./xml.adoc#xml,XML Support - Dealing with XML Payloads>> ::
57-
<<./xmpp.adoc#xmpp,XMPP Support>> ::
58-
<<./zeromq.adoc#zeromq,ZeroMQ Support>> ::
59-
<<./zookeeper.adoc#zookeeper,Zookeeper Support>> ::
35+
<<./endpoint-summary.adoc#spring-integration-endpoints,Integration Endpoint Summary>> :: Protocol-specific channel adapters and gateways summary
36+
<<./amqp.adoc#amqp,AMQP Support>> :: AMQP channels, adapters and gateways
37+
<<./event.adoc#applicationevent,Spring `ApplicationEvent` Support>> :: Handling and consuming Spring application events with channel adapters
38+
<<./feed.adoc#feed,Feed Adapter>> :: RSS and Atom channel adapters
39+
<<./file.adoc#files,File Support>> :: Channel adapters and gateways for file system support
40+
<<./ftp.adoc#ftp,FTP/FTPS Adapters>> :: Channel adapters and gateways for FTP protocol
41+
<<./gemfire.adoc#gemfire,Pivotal GemFire and Apache Geode Support>> :: Apache Geode channel adapters, message store
42+
<<./graphql.adoc#graphql,GraphQL Support>> :: Channel adapters for GraphQL
43+
<<./http.adoc#http,HTTP Support>> :: Channel adapters and gateways for HTTP communication
44+
<<./jdbc.adoc#jdbc,JDBC Support>> :: Channel adapters and gateways for JDBC, message and metadata stores
45+
<<./jpa.adoc#jpa,JPA Support>> :: Channel adapters and gateways for JPA API
46+
<<./jms.adoc#jms,JMS Support>> :: Channel adapters and gateways for JMS API
47+
<<./jmx.adoc#jmx,JMX Support>> :: Channel adapters for JMX interaction, integration-specific MBean exporter
48+
<<./kafka.adoc#kafka,Apache Kafka Support>> :: Channels, adapters and gateways for Apache Kafka
49+
<<./mail.adoc#mail,Mail Support>> :: Channel adapters for Java Mail API
50+
<<./mongodb.adoc#mongodb,MongoDb Support>> :: Channels, adapters, gateways and message store for MongoDb
51+
<<./mqtt.adoc#mqtt,MQTT Support>> :: Channel adapters for MQTT protocol
52+
<<./r2dbc.adoc#r2dbc,R2DBC Support>> :: Channel adapters for R2DBC API
53+
<<./redis.adoc#redis,Redis Support>> :: Channels, adapters, gateways and message store for Redis
54+
<<./resource.adoc#resource,Resource Support>> :: Spring resource channel adapters
55+
<<./rsocket.adoc#rsocket,RSocket Support>> :: Channel adapters for RSocket protocol
56+
<<./sftp.adoc#sftp,SFTP Adapters>> :: Channel adapters and gateways for FTP protocol
57+
<<./smb.adoc#smb,SMB Support>> :: Channel adapters and gateways for SMB protocol
58+
<<./stomp.adoc#stomp,STOMP Support>> :: Channel adapters and gateways for STOMP protocol
59+
<<./stream.adoc#stream,Stream Support>> :: Channel adapters for Java IO stream API
60+
<<./syslog.adoc#syslog,Syslog Support>> :: Channel adapters for Syslog protocol
61+
<<./ip.adoc#ip,TCP and UDP Support>> :: Channel adapters and gateways for TCP and UDP protocols
62+
<<./webflux.adoc#webflux,WebFlux Support>> :: Channel adapters and gateways for WebFlux API
63+
<<./web-sockets.adoc#web-sockets,WebSockets Support>> :: Channel adapters for WebSockets protocol
64+
<<./ws.adoc#ws,Web Services Support>> :: Channel adapters for SOAP protocol
65+
<<./xml.adoc#xml,XML Support - Dealing with XML Payloads>> :: Channel adapters and transformers for XML API, xPath
66+
<<./xmpp.adoc#xmpp,XMPP Support>> :: Channel adapters for XMPP protocol
67+
<<./zeromq.adoc#zeromq,ZeroMQ Support>> :: Channels and adapters for ZeroMQ protocol
68+
<<./zookeeper.adoc#zookeeper,Zookeeper Support>> :: Channel adapters for Zookeeper and Curator API
6069

6170
[horizontal]
6271
**Appendices** ::
6372

6473
[horizontal]
65-
<<./error-handling.adoc#error-handling,Error Handling>> ::
66-
<<./spel.adoc#spel,Spring Expression Language (SpEL)>> ::
67-
<<./message-publishing.adoc#message-publishing,Message Publishing>> ::
68-
<<./transactions.adoc#transactions,Transaction Support>> ::
69-
<<./security.adoc#security,Security in Spring Integration>> ::
70-
<<./configuration.adoc#configuration,Configuration>> ::
71-
<<./testing.adoc#testing,Testing support>> ::
72-
<<./samples.adoc#samples,Spring Integration Samples>> ::
73-
<<./resources.adoc#resources,Additional Resources>> ::
74-
<<./history.adoc#history,Change History>> ::
74+
<<./error-handling.adoc#error-handling,Error Handling>> :: Overview of error handling approaches in Spring Integration
75+
<<./spel.adoc#spel,Spring Expression Language (SpEL)>> :: Details about SpEL support
76+
<<./message-publishing.adoc#message-publishing,Message Publishing>> :: The Publisher annotation etc.
77+
<<./transactions.adoc#transactions,Transaction Support>> :: Overview of transactions support in Spring Integration
78+
<<./security.adoc#security,Security in Spring Integration>> :: Securing Spring Integration flows
79+
<<./configuration.adoc#configuration,Configuration>> :: Messaging annotations, task scheduler, global properties, message to POJO method arguments mapping
80+
<<./testing.adoc#testing,Testing support>> :: Test utilities, Integration mocks and testing framework
81+
<<./samples.adoc#samples,Spring Integration Samples>> :: The samples dedicated project
82+
<<./resources.adoc#resources,Additional Resources>> :: Other resources related to project
83+
<<./history.adoc#history,Change History>> :: The changes made in the project over time

src/reference/asciidoc/preface.adoc

+23
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,26 @@ Be aware, though, that SpringSource Tool Suite™ (STS) uses the same namespace
6868
== Conventions in This Guide
6969

7070
In some cases, to aid formatting when specifying long fully qualified class names, we shorten `org.springframework` to `o.s` and `org.springframework.integration` to `o.s.i`, such as with `o.s.i.transaction.TransactionSynchronizationFactory`.
71+
72+
[[overview-feedback]]
73+
== Feedback and Contributions
74+
75+
For how-to questions or diagnosing or debugging issues, we suggest using Stack Overflow.
76+
Click https://stackoverflow.com/questions/tagged/spring-integration?tab=Newest[here] for a list of the latest questions.
77+
If you're fairly certain that there is a problem in the Spring Integration or would like to suggest a feature, please use the https://github.com/spring-projects/spring-integration/issues[GitHub Issues].
78+
79+
If you have a solution in mind or a suggested fix, you can submit a pull request on https://github.com/spring-projects/spring-integration[GitHub].
80+
However, please keep in mind that, for all but the most trivial issues, we expect a ticket to be filed in the issue tracker, where discussions take place and leave a record for future reference.
81+
82+
For more details see the guidelines at the https://github.com/spring-projects/spring-integration/blob/main/CONTRIBUTING.adoc[CONTRIBUTING], top-level project page.
83+
84+
85+
[[overview-getting-started]]
86+
== Getting Started
87+
88+
If you are just getting started with Spring Integration, you may want to begin by creating a https://projects.spring.io/spring-boot/[Spring Boot]-based application.
89+
Spring Boot provides a quick (and opinionated) way to create a production-ready Spring-based application.
90+
It is based on the Spring Framework, favors convention over configuration, and is designed to get you up and running as quickly as possible.
91+
92+
You can use https://start.spring.io/[start.spring.io] to generate a basic project (add `integration` as dependency) or follow one of the https://spring.io/guides["Getting Started" guides], such as https://spring.io/guides/gs/integration/[Getting Started Building an Integrating Data].
93+
As well as being easier to digest, these guides are very task focused, and most of them are based on Spring Boot.

0 commit comments

Comments
 (0)