Skip to content

Commit

Permalink
Polishing
Browse files Browse the repository at this point in the history
  • Loading branch information
@mp911de
mp911de committed Jan 21, 2017
1 parent cec0c77 commit 8baf723
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 52 deletions.
52 changes: 13 additions & 39 deletions pom.xml
View file
Expand Up @@ -482,16 +482,9 @@

<profile>

<!--
Profile to be activated when building the distribution atrifacts.
Generates reference documentation, aggregates JavaDoc etc. Has to be combined with
profiles "release" or "milestone" to deploy artifacts into the appropriate places.
-->

<id>distribute</id>

<properties>
<shared.resources>${project.build.directory}/shared-resources</shared.resources>
<maven.install.skip>true</maven.install.skip>
<skipTests>true</skipTests>
</properties>
Expand All @@ -518,73 +511,55 @@
</executions>
</plugin>

<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
</plugin>

<!--
Copies all namespaces schemas to target/schemas flatten the directory structure.
-->

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
<version>1.8</version>
<executions>

<execution>
<id>copy-documentation-resources</id>
<phase>generate-resources</phase>
<id>rename-reference-docs</id>
<phase>process-resources</phase>
<configuration>
<target>
<copy todir="${project.basedir}/target/site/reference/html">
<fileset dir="${shared.resources}/asciidoc" erroronmissingdir="false">
<include name="**/*.css"/>
</fileset>
<flattenmapper/>
</copy>
<copy todir="${project.basedir}/target/site/reference/html/images">
<fileset dir="${basedir}/src/main/asciidoc" erroronmissingdir="false">
<include name="**/*.png"/>
<include name="**/*.gif"/>
<include name="**/*.jpg"/>
</fileset>
<flattenmapper/>
</copy>
<copy failonerror="false"
file="${project.build.directory}/generated-docs/index.pdf"
tofile="target/site/reference/pdf/lettuce-reference.pdf"/>
</target>
</configuration>
<goals>
<goal>run</goal>
</goals>
</execution>

</executions>
</plugin>

<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
</plugin>

</plugins>


<pluginManagement>
<plugins>


<!--
Asciidoctor
-->

<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>1.5.3</version>
<dependencies>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-pdf</artifactId>
<version>1.5.0-alpha.11</version>
</dependency>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-epub3</artifactId>
<version>1.5.0-alpha.6</version>
</dependency>
</dependencies>
<executions>

Expand Down Expand Up @@ -616,7 +591,6 @@
</goals>
<configuration>
<backend>pdf</backend>
<outputDirectory>target/site/reference</outputDirectory>
</configuration>
</execution>

Expand Down
2 changes: 1 addition & 1 deletion src/main/asciidoc/ha-sharding.asciidoc
View file
Expand Up @@ -6,7 +6,7 @@
:cco-adaptive-link: <<clientoptions.cluster-specific-options,Adaptive updates>>

[[ha-sharding]]
== HA and Sharding
== High-Availability and Sharding

[[master-slave]]
=== Master/Slave
Expand Down
4 changes: 2 additions & 2 deletions src/main/asciidoc/index.asciidoc
View file
@@ -1,4 +1,4 @@
= Lettuce Guide
= Lettuce Reference Guide
Mark Paluch <https://twitter.com/mp911de[@mp911de]>;
:ext-doc: https://raw.githubusercontent.com/wiki/mp911de/lettuce/
{version}
Expand All @@ -8,7 +8,7 @@ Mark Paluch <https://twitter.com/mp911de[@mp911de]>;
:sectnums:
:sectanchors:

include::preface.asciidoc[]
include::overview.asciidoc[]

include::getting-started.asciidoc[]

Expand Down
32 changes: 22 additions & 10 deletions src/main/asciidoc/preface.asciidoc → src/main/asciidoc/overview.asciidoc
View file
@@ -1,25 +1,37 @@
[[preface]]
== Preface
[[overview]]
== Overview

Lettuce is a scalable thread-safe Redis client providing <<basic-usage,synchronous>, <<asynchronous-api,asynchronous>> and <<reactive-api,reactive>> APIs. Multiple threads may share one connection if they avoid blocking and transactional operations such as BLPOP and MULTI/EXEC. Multiple connections are efficiently managed by the excellent netty NIO framework. Support for advanced Redis features such as Sentinel, Cluster, and Redis data models is included.

This document is the reference guide for lettuce. It explains how to use lettuce, its concepts and semantics and the syntax.
This document is the reference guide for lettuce. It explains how to use lettuce, its concepts, semantics, and the syntax.

You can read this reference guide in a linear fashion, or you can skip sections if something does not interest you.

This section provides some basic introduction to Redis. The rest of the document refers only to lettuce features and assumes the user is familiar with Redis concepts.

[[preface.redis]]
[[overview.redis]]
=== Knowing Redis
NoSQL stores have taken the storage world by storm. It is a vast domain with a plethora of solutions, terms and patterns (to make things worse even the term itself has multiple http://www.google.com/search?q=nosoql+acronym[meanings]). While some of the principles are common, it is crucial that the user is familiar to some degree with Redis. The best way to get acquainted to this solutions is to read their documentation and follow their documentation - it usually doesn't take more then 5-10 minutes to go through them and if you are coming from an RDMBS-only background many times these exercises can be an eye opener.

The jumping off ground for learning about Redis is http://www.redis.io/[redis.io]. Here is a list of other useful resources:

* The http://try.redis.io/[interactive tutorial] introduces Redis.
* The http://redis.io/commands[command references] explains Redis commands and contains links to getting started guides, reference documentation and tutorials.
* Redis https://redis.io/clients[Clients]

[[preface.requirements]]
=== Project Reactor

https://projectreactor.io[Reactor] is a highly optimized reactive library for building efficient, non-blocking
applications on the JVM based on the https://github.com/reactive-streams/reactive-streams-jvm[Reactive Streams Specification].
Reactor based applications can sustain very high throughput message rates and operate with a very low memory footprint,
making it suitable for building efficient event-driven applications using the microservices architecture.

Reactor implements two publishers https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Flux.html[Flux<T>] and
https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html[Mono<T>], both of which support non-blocking back-pressure.
This enables exchange of data between threads with well-defined memory usage, avoiding unnecessary intermediate buffering or blocking.

=== Non-blocking API for Redis

Lettuce is a scalable thread-safe Redis client based on http://netty.io[netty] and Reactor. Lettuce provides <<basic-usage,synchronous>>, <<asynchronous-api,asynchronous>> and <<reactive-api,reactive>> APIs to interact with Redis.

[[overview.requirements]]
=== Requirements

lettuce 4.x and 5.x binaries requires JDK level 8.0 and above.
Expand All @@ -30,7 +42,7 @@ In terms of http://redis.io/[Redis], at least 2.6.

Learning a new framework is not always straight forward. In this section, we try to provide what we think is an easy to follow guide for starting with lettuce. However, if you encounter issues or you are just looking for an advice, feel free to use one of the links below:

[[preface.support]]
[[overview.support]]
==== Support

There are a few support options available:
Expand All @@ -40,7 +52,7 @@ There are a few support options available:
* Google Group: https://groups.google.com/d/forum/lettuce-redis-client-users[lettuce-redis-client-users] or mailto:lettuce-redis-client-users@googlegroups.com
* Report bugs (or ask questions) in Github issues https://github.com/mp911de/lettuce/issues

[[preface.development]]
[[overview.development]]
==== Following Development

For information on the lettuce source code repository, nightly builds and snapshot artifacts please see the https://redis.paluch.biz[lettuce homepage]. You can help make lettuce best serve the needs of the lettuce community by interacting with developers through the Community on http://stackoverflow.com/questions/tagged/lettuce[Stackoverflow]. To follow developer activity look for the mailing list information on the https://redis.paluch.biz[lettuce homepage]. If you encounter a bug or want to suggest an improvement, please create a ticket on the lettuce issue https://github.com/mp911de/lettuce/issues[tracker].
Expand Down

0 comments on commit 8baf723

Please sign in to comment.