Draft: #1542 - Migrate Documentation from Wiki to Living Documentation in Code #1714
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a WIP / DRAFT PR to migrate our documentation from wiki to living documentation in a separate code module to allow for faster documentation updates / review cycles since the wiki doesn't have such a mechanism.
Most pages were automatically converted from wiki markdown to ascii format.
I have added some additional pages to ease a quick start with StormCrawler.
The only thing left is, that I plan to add an architectural image to get an high level overview how the different streams / bolts / spouts interact with each other.