[GEARPUMP-305] Add Internals section to docs
Author: manuzhang <owenzhang1990@gmail.com>
Closes #181 from manuzhang/doc.
diff --git a/docs/contents/dev/dev-storm.md b/docs/contents/dev/dev-storm.md
index e60b505..cf3e7e5 100644
--- a/docs/contents/dev/dev-storm.md
+++ b/docs/contents/dev/dev-storm.md
@@ -146,13 +146,13 @@
Storm tracks the lineage of each message with ackers to guarantee at-least-once message delivery. Failed messages are re-sent from spout.
-Gearpump [tracks messages between a sender and receiver in an efficient way](../introduction/gearpump-internals#how-do-we-detect-message-loss). Message loss causes the whole application to replay from the [minimum timestamp of all pending messages in the system](../introduction/gearpump-internals#application-clock-and-global-clock-service).
+Gearpump [tracks messages between a sender and receiver in an efficient way](../internals/gearpump-internals#how-do-we-detect-message-loss). Message loss causes the whole application to replay from the [minimum timestamp of all pending messages in the system](../internals/gearpump-internals#application-clock-and-global-clock-service).
### Flow control
Storm throttles flow rate at spout, which stops sending messages if the number of unacked messages exceeds `topology.max.spout.pending`.
-Gearpump has flow control between tasks such that [sender cannot flood receiver](../introduction/gearpump-internals#how-do-we-do-flow-control), which is backpressured till the source.
+Gearpump has flow control between tasks such that [sender cannot flood receiver](../internals/gearpump-internals#how-do-we-do-flow-control), which is backpressured till the source.
### Configurations
diff --git a/docs/contents/dev/dev-write-1st-app.md b/docs/contents/dev/dev-write-1st-app.md
index 166b1e2..6234577 100644
--- a/docs/contents/dev/dev-write-1st-app.md
+++ b/docs/contents/dev/dev-write-1st-app.md
@@ -25,8 +25,7 @@
}
}
-The example is written in our [Stream DSL]
-(http://gearpump.apache.org/releases/latest/api/scala/index.html#org.apache.gearpump.streaming.dsl.Stream), which provides you with convenient combinators (e.g. `flatMap`, `groupByKey`) to easily write up transformations.
+The example is written in our [Stream DSL](http://gearpump.apache.org/releases/latest/api/scala/index.html#org.apache.gearpump.streaming.dsl.Stream), which provides you with convenient combinators (e.g. `flatMap`, `groupByKey`) to easily write up transformations.
### IDE Setup (Optional)
diff --git a/docs/contents/index.md b/docs/contents/index.md
index 1cd98b8..624986c 100644
--- a/docs/contents/index.md
+++ b/docs/contents/index.md
@@ -30,6 +30,3 @@
-### Gearpump and Akka
-Gearpump is a 100% Akka based platform. We model big data streaming within the Akka actor hierarchy.
-
diff --git a/docs/contents/introduction/gearpump-internals.md b/docs/contents/internals/gearpump-internals.md
similarity index 100%
rename from docs/contents/introduction/gearpump-internals.md
rename to docs/contents/internals/gearpump-internals.md
diff --git a/docs/contents/introduction/message-delivery.md b/docs/contents/introduction/message-delivery.md
index 1ffeb9e..c2cb4a0 100644
--- a/docs/contents/introduction/message-delivery.md
+++ b/docs/contents/introduction/message-delivery.md
@@ -3,7 +3,7 @@
Messages could be lost on delivery due to network partitions. **At Least Once Message Delivery** (at least once) means the lost messages are delivered one or more times such that at least one is processed and acknowledged by the whole flow.
Gearpump guarantees at least once for any source that is able to replay message from a past timestamp. In Gearpump, each message is tagged with a timestamp, and the system tracks the minimum timestamp of all pending messages (the global minimum clock). On message loss, application will be restarted to the global minimum clock. Since the source is able to replay from the global minimum clock, all pending messages before the restart will be replayed. Gearpump calls that kind of source `TimeReplayableSource` and already provides a built in
-[KafkaSource](gearpump-internals#at-least-once-message-delivery-and-kafka). With the KafkaSource to ingest data into Gearpump, users are guaranteed at least once message delivery.
+[KafkaSource](../internals/gearpump-internals#at-least-once-message-delivery-and-kafka). With the KafkaSource to ingest data into Gearpump, users are guaranteed at least once message delivery.
## What is Exactly Once Message Delivery?
@@ -44,4 +44,4 @@
1. has binary associative operation, like `+`
2. has an identity element, like `0`
-In the above example, we make use of the `longMonoid` from [Twitter's Algebird](https://github.com/twitter/algebird) library which provides a bunch of useful monoids.
\ No newline at end of file
+In the above example, we make use of the `longMonoid` from [Twitter's Algebird](https://github.com/twitter/algebird) library which provides a bunch of useful monoids.
diff --git a/docs/contents/introduction/submit-your-1st-application.md b/docs/contents/introduction/submit-your-1st-application.md
index 21cfaf2..5f9028d 100644
--- a/docs/contents/introduction/submit-your-1st-application.md
+++ b/docs/contents/introduction/submit-your-1st-application.md
@@ -32,8 +32,7 @@
**NOTE:** the UI port setting can be defined in configuration, please check section [Configuration](../deployment/deployment-configuration).
-## A quick Look at the Web UI
-TBD
-
## Other Application Examples
-Besides wordcount, there are several other example applications. Please check the source tree examples/ for detail information.
+Besides wordcount, there are several other example applications. Please check the source tree `examples/` for detail information.
+
+
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 6e23e41..7ce5287 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -19,7 +19,6 @@
- 'Technical Highlights': 'introduction/features.md'
- 'Reliable Message Delivery': 'introduction/message-delivery.md'
- 'Performance': 'introduction/performance-report.md'
- - 'Gearpump Internals': 'introduction/gearpump-internals.md'
- Deployment:
- 'Local Mode': 'deployment/deployment-local.md'
- 'Standalone Mode': 'deployment/deployment-standalone.md'
@@ -43,6 +42,8 @@
- 'REST API': 'dev/dev-rest-api.md'
- 'Scala API': 'api/scala.md'
- 'Java API': 'api/java.md'
+- Internals:
+ - 'Gearpump Internals': 'internals/gearpump-internals.md'
theme: readthedocs
