search

salesforce / storm-dynamic-spout

A framework for building spouts for Apache Storm and a Kafka based spout for dynamically skipping messages to be processed later.
BSD 3-Clause "New" or "Revised" License
40 stars 13 forks source link

Documentation re-arrangement #65

Closed Crim closed 6 years ago

Crim commented 6 years ago

Looking at #19 one of the required changes is how we generate our docs. Currently the generator pulls in dependencies across what will become separate modules.

This PR moves the Doc generating logic out, and allows each "module" to call the generator passing in the bits it needs to build its documentation.

Crim commented 6 years ago

So this isn't the 100% cleanest/DRY solution, but I think it satisfies what I was going for. Removing the cross-package pollution, with now adding hooks for generating metric docs.

The README as a whole needs an overhaul ( see #8 ) but we're in a better spot than we were before the PR. I also believe how we deal w/ Configs also needs some re-tooling ( #80 )