<commit_before>= Desired User Documentation

This is an initial attempt to begin listing the different things that
should be documented for the enmasse system. Additions, corrections
and other changes are all very welcome!

== Installation Guide

Similar to the link:../getting-started/README.md[getting started
guide], a description of how to install enmasse for different
scenarios.

== Service Catalog Service descriptions

When creating addresses of different types through the service broker,
there is the facility to provide descriptions of the services and
links to further information. Below are two screenshots, encountered
when creating a queue:

image::screenshot_service_catalog_queue_1.png

image::screenshot_service_catalog_queue_2.png

For each service type - queue, topic, direct-anycast and
direct-multicast - we should provide:

* a one sentence description of that pattern of communication<commit_msg>fix image links<commit_after>ifdef::env-github[]
:imagesdir: https://github.com/EnMasseProject/enmasse/raw/master/documentation/userdoc/
endif::[]
= Desired User Documentation

This is an initial attempt to begin listing the different things that
should be documented for the enmasse system. Additions, corrections
and other changes are all very welcome!

== Installation Guide

Similar to the link:../getting-started/README.md[getting started
guide], a description of how to install enmasse for different
scenarios.

== Service Catalog Service descriptions

When creating addresses of different types through the service broker,
there is the facility to provide descriptions of the services and
links to further information. Below are two screenshots, encountered
when creating a queue:

image::screenshot_service_catalog_queue_1.png[]

image::screenshot_service_catalog_queue_2.png[]

For each service type - queue, topic, direct-anycast and
direct-multicast - we should provide:

* a one sentence description of that pattern of communication
{'fraction_non_alphanumeric': 0.0539714867617108, 'fraction_numerical': 0.002036659877800407, 'mean_word_length': 5.638513513513513, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3726754', 'n_tokens_mistral': 499, 'n_tokens_neox': 483, 'n_words': 226}