expand broker internal documentation to cover bootstrap phase #3618
Conversation
This file contains 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
Problem: one page of broker documentation is getting a bit crowded. Create one top level page and one page each for bootstrap and state machine.
Problem: the color key under the state machine diagram was noted to be confusing earlier by @SteVwonder, but apparently was not fixed. Reword the color key for clarity.
|
This is great. I wonder if there is a way to get this documentation to be included in the RTD site? (Or is it there and I just can't find it?) |
Codecov Report
@@ Coverage Diff @@
## master #3618 +/- ##
=======================================
Coverage 82.61% 82.62%
=======================================
Files 324 324
Lines 49113 49113
=======================================
+ Hits 40576 40578 +2
+ Misses 8537 8535 -2
|
|
Thanks!
I was think of it more as documentation needed for working on the internals of the broker, but admittedly the bootstrap stuff is likely to be useful to users debugging flux on a new system. Maybe we should think about promoting some of it to a man page at some point? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 updates the in situ markdown documentation for broker internals to cover the bootstrap phase more comprehensively, splitting that out to a separate page. This is not really related to the topic branch I had it on, so submitting separately.