search

AxonIQ / reference-guide

The Axon Reference Guide
https://docs.axoniq.io
Other
41 stars 44 forks source link

Configuration API documentation missing #88

Open sgrimm-sg opened 5 years ago

sgrimm-sg commented 5 years ago

Axon 3's docs have a section describing the Configuration API, but there seems to be no documentation of that API at all in the Axon 4 version of the documentation.

smcvb commented 5 years ago

Thanks for pointing this out @sgrimm-sg. When we updated the framework from Axon 3 to Axon 4, we also did a massive shuffle of all the pages in the Reference Guide for improvements.

Some parts have been merged with others, the Configuration API section being one of them. The idea is that the specific Configuration Block per page specifies how to configure it.

However, I am assuming it doesn't quite so, otherwise you wouldn't have asked for this to come back. We'll look into resolving this, thanks for marking it Steven.

sgrimm-sg commented 5 years ago

The docs do contain configuration snippets for the specific components, but what’s missing, as far as I could tell, is any kind of introduction or high-level description of how the configuration API works as a whole, when to call it, and so on.

smcvb commented 5 years ago

Thanks for pointing this out Steven, that narrows the feature request down a little. :+1: