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 PR started out of the need/want to create a flow chart of the logic of Pulsar as a whole, to remove the need to go trawling through the source code to find who initializes what, when. While the included documents don't totally solve this problem, in my opinion it does help considerable.
I've added two new documents here:
The tools to create these charts are open source, freely available, and have online editors, ensuring anyone on the team is easily able to update them as needed.
Lastly, within the
./docs/README.md
I noticed most of the links were totally broken after the sunset, so those have been updated, as well as adding links to the new documents I've added.I know the written content isn't perfect, but really my goal was to include the charts, and some other slightly helpful info.