SpringCloud/spring-cloud-stream
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation styles polishing

Browse Source
This commit is contained in:
Oleg Zhurakousky
2019-03-14 18:06:19 +01:00
parent 1fc8db0e9e
commit 1d6242bf9a
2 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/pom.xml
View File

@@ -15,7 +15,7 @@
<properties>
<docs.main>index</docs.main>
<main.basedir>${basedir}/..</main.basedir>
<spring-doc-resources.version>0.1.0.RELEASE</spring-doc-resources.version>
<spring-doc-resources.version>0.1.1.BUILD-SNAPSHOT</spring-doc-resources.version>
<spring-asciidoctor-extensions.version>0.1.0.RELEASE
</spring-asciidoctor-extensions.version>
<asciidoctorj-pdf.version>1.5.0-alpha.16</asciidoctorj-pdf.version>
@@ -123,6 +123,10 @@
<sourceDirectory>${project.build.directory}/refdocs/</sourceDirectory>
<attributes>
<spring-cloud-stream-version>${project.version}</spring-cloud-stream-version>
<docs-url>http://cloud.spring.io/</docs-url>
<docs-version></docs-version>
<!-- <docs-version>${project.version}/</docs-version> -->
<!-- <docs-url>http://cloud.spring.io/spring-cloud-static/</docs-url> -->
</attributes>
</configuration>
<executions>
@@ -152,7 +156,6 @@
<spring-cloud-version>${project.version}</spring-cloud-version>
<sectlinks>true</sectlinks>
</attributes>
<!-- <outputFile>${docs.main}.html</outputFile> -->
</configuration>
</execution>
<execution>

14
docs/src/main/asciidoc/index.adoc
View File

@@ -5,14 +5,18 @@ Sabby Anandan; Marius Bogoevici; Eric Bottard; Mark Fisher; Ilayaperumal Gopinat
:docinfo: shared
[#index-link]
{docs-url}spring-cloud-stream/{docs-version}
The reference documentation consists of the following sections:
[horizontal]
<<spring-cloud-stream.adoc#spring-cloud-stream-reference,Reference Guide>> :: Spring Cloud Stream Reference
http://cloud.spring.io/spring-cloud-static/spring-cloud-stream-binder-rabbit/{spring-cloud-stream-version}/[Rabbit MQ Binder] :: Rabbit MQ Binder Reference
http://cloud.spring.io/spring-cloud-static/spring-cloud-stream-binder-kafka/{spring-cloud-stream-version}/[Apache Kafka Binder] :: Apache Kafka Binder Reference
https://github.com/spring-cloud/spring-cloud-stream-samples/[Spring Cloud Stream Samples] :: Spring Cloud Stream Samples repository
<<binders.adoc#binders,Additional Binders>> :: More Binders implementations
<<spring-cloud-stream.adoc#spring-cloud-stream-reference,Overview>> :: History, Quick Start, Concepts, Architecture Overview, Binder Abstraction, and Core Features
{docs-url}spring-cloud-stream-binder-rabbit/{docs-version}spring-cloud-stream-binder-rabbit.html[Rabbit MQ Binder] :: Spring Cloud Stream binder reference for Rabbit MQ
{docs-url}spring-cloud-stream-binder-kafka/{docs-version}spring-cloud-stream-binder-kafka.html[Apache Kafka Binder] :: Spring Cloud Stream binder reference for Apache Kafka
{docs-url}spring-cloud-stream-binder-kafka/{docs-version}spring-cloud-stream-binder-kafka.html#_kafka_streams_binder[Apache Kafka Streams Binder] :: Spring Cloud Stream binder reference for Apache Kafka Streams
<<binders.adoc#binders,Additional Binders>> :: A collection of Partner maintained binder implementations for Spring Cloud Stream (e.g., Azure Event Hubs, Google PubSub, Solace PubSub+)
https://github.com/spring-cloud/spring-cloud-stream-samples/[Spring Cloud Stream Samples] :: A curated collection of repeatable Spring Cloud Stream samples to walk through the features
Relevant Links: