Add a User's Guide

[minborg]

The User's Guide should be structured in a concise and coherent way teaching newbies and experts how to use the product and how to benefit from enterprise features.

Examples from the Demo should be included.

[minborg]

Most software products have what collectively are called "documentation", "user's guide", "product documentation", "manual" etc.

Here are some examples:

• Kafka https://kafka.apache.org/documentation/
• Hazelcast https://docs.hazelcast.com/imdg/4.2/getting-started
• Tensorflow https://www.tensorflow.org/guide

So, the idea here is to set up a real manual (using adoc files) that can be rendered to a real navigable online manual using , for example, Antora. Rendering tools can oftentimes also generated PDF files and keeps track of different versions etc.

The Chronicle Queue User Guide will discuss both open source features as well as enterprise features and will thus also work as a shopping window for enterprise features.

[julgus]

Definition of done: A first version of the chapter is provided and presumingly, most of the relevant topics are covered.

We will have to organize reviews of the texts later.

• Introduction
• What is Chronicle Queue
• Getting Started
• Use Cases
• Glossary
• Configuration
• Roll cycle
• Wire type
• Block size
• Index count
• Index spacing
• Buffer modes
• Queue operations
• Appending
• Tailing
• Indexing
• Read/write proxies
• Performance tuning
• Pre-touching
• Contended writes
• Queue replication
• Monitoring repplication
• Ring buffer (Async mode)
• Encryption
• Advanced
• Demos