Skip to content

Loading…

Table of contents for user guide #80

Merged
merged 2 commits into from

1 participant

@krasserm
Eligosource member

No description provided.

@krasserm krasserm merged commit 3e05dbc into master
@krasserm krasserm deleted the wip-docs branch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Mar 25, 2013
  1. @krasserm
  2. @krasserm

    Add table of contents

    krasserm committed
Showing with 72 additions and 21 deletions.
  1. +72 −21 README.md
View
93 README.md
@@ -14,6 +14,57 @@ Eventsourced
</tr>
</table>
+Contents
+--------
+
+- [Overview](#overview)
+ - [Building blocks](#building-blocks)
+ - [Processor](#processor)
+ - [Channel](#channel)
+ - [Journal](#journal)
+ - [Application](#application)
+ - [Journals](#journals)
+- [Terminology](#terminology)
+- [First steps](#first-steps)
+ - [Step 1: EventsourcingExtension initialization](#step-1-eventsourcingextension-initialization)
+ - [Step 2: Event-sourced actor definition](#step-2-event-sourced-actor-definition)
+ - [Step 3: Event-sourced actor creation and recovery](#step-3-event-sourced-actor-creation-and-recovery)
+ - [Step 4: Event-sourced actor usage](#step-4-event-sourced-actor-usage)
+ - [Step 5: Channel usage](#step-5-channel-usage)
+- [Stackable traits](#stackable-traits)
+ - [Eventsourced](#eventsourced-1)
+ - [Receiver](#receiver)
+ - [Emitter](#emitter)
+ - [Confirm](#confirm)
+ - [Modified example](#modified-example)
+- [Sender references](#sender-references)
+- [Channels](#channels)
+ - [DefaultChannel](#defaultchannel)
+ - [ReliableChannel](#reliablechannel)
+ - [Reliable request-reply channel](#reliable-request-reply-channel)
+ - [Usage hints](#usage-hints)
+ - [Alternatives](#alternatives)
+- [Recovery](#recovery)
+ - [Await processing](#await-processing)
+ - [Non-blocking recovery](#non-blocking-recovery)
+ - [State dependencies](#state-dependencies)
+- [Behavior changes](#behavior-changes)
+- [Event series](#event-series)
+- [Idempotency](#idempotency)
+- [Serialization](#serialization)
+- [Further examples](#further-examples)
+ - [Order management](#order-management)
+ - [State machines](#state-machines)
+ - [Clustering](#clustering)
+- [Miscellaneous](#miscellaneous)
+ - [Multicast processor](#multicast-processor)
+ - [Retroactive changes](#retroactive-changes)
+ - [Snapshots](#snapshots)
+- [Appendix A: Legend](#appendix-a-legend)
+- [Appendix B: Project](#appendix-b-project)
+- [Appendix C: Articles](#appendix-c-articles)
+- [Appendix D: Support](#appendix-d-support)
+
Overview
--------
@@ -125,27 +176,6 @@ Terminology
In the following, the terms *persistent actor*, *event-sourced actor*, *event-sourced processor* and *processor* are used interchangeably. Furthermore, a [`Message`](http://eligosource.github.com/eventsourced/api/snapshot/#org.eligosource.eventsourced.core.Message) is often referred to as *event message*.
-Resources
----------
-
-### Project
-
-- [Eventsourced API](http://eligosource.github.com/eventsourced/api/snapshot/#org.eligosource.eventsourced.core.package)
-- [Eventsourced reference application](https://github.com/eligosource/eventsourced-example)
-- [Installation](https://github.com/eligosource/eventsourced/wiki/Installation).
-- [FAQ](https://github.com/eligosource/eventsourced/wiki/FAQ)
-- [Developer guidelines](https://github.com/eligosource/eventsourced/wiki/Developer-guidelines)
-
-### Articles
-
-- [Event sourcing and external service integration](http://krasserm.blogspot.com/2013/01/event-sourcing-and-external-service.html)
-
-### Support
-
-- [Eventsourced user forum](http://groups.google.com/group/eventsourced)
-- [Eventsourced developer forum](http://groups.google.com/group/eventsourced-dev)
-- Commercial support by [Eligotech B.V.](http://www.eligotech.com/)
-
First steps
-----------
@@ -1134,3 +1164,24 @@ Appendix A: Legend
------------------
![Legend](https://raw.github.com/eligosource/eventsourced/master/doc/images/legend.png)
+
+Appendix B: Project
+-------------------
+
+- [Eventsourced API](http://eligosource.github.com/eventsourced/api/snapshot/#org.eligosource.eventsourced.core.package)
+- [Eventsourced reference application](https://github.com/eligosource/eventsourced-example)
+- [Installation](https://github.com/eligosource/eventsourced/wiki/Installation)
+- [FAQ](https://github.com/eligosource/eventsourced/wiki/FAQ)
+- [Developer guidelines](https://github.com/eligosource/eventsourced/wiki/Developer-guidelines)
+
+Appendix C: Articles
+--------------------
+
+- [Event sourcing and external service integration](http://krasserm.blogspot.com/2013/01/event-sourcing-and-external-service.html)
+
+Appendix D: Support
+--------------------
+
+- [Eventsourced user forum](http://groups.google.com/group/eventsourced)
+- [Eventsourced developer forum](http://groups.google.com/group/eventsourced-dev)
+- Commercial support by [Eligotech B.V.](http://www.eligotech.com/)
Something went wrong with that request. Please try again.