docs: updates to the developers guide #10771
Merged
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
Merged
Member
Author
|
bot:aws:recheck |
jjhursey
suggested changes
Sep 7, 2022
Member
jjhursey
left a comment
jjhursey
left a comment
There was a problem hiding this comment.
A few minor-ish notes, but otherwise an improvement. Thanks!
* Removed a bunch of redundant text and replaced it with links to elsewhere in the docs. * Added developer-level rules of thumb for levels 1-9 of MCA params. * Added code style documentation; consolidated this and "source code tree layout" into a single source-code.rst file. Signed-off-by: Jeff Squyres <[email protected]>
Note on the front page that the v5.0.0 docs are on the public web site, in the tarball, and installed locally. Signed-off-by: Jeff Squyres <[email protected]>
jsquyres
force-pushed
the
pr/docs/developer-updates
branch
from
2bc253a to
f33d3d4
Compare
Member
Author
|
@jjhursey I made all the suggested changes. I also added another commit that updates the front page to show all 3 locations of the v5.0.0 docs (public web site, in the tarball, and installed). Once merged, this 2nd commit should be pulled to the v4.0.x and v4.1.x branches. See https://ompi--10771.org.readthedocs.build/en/10771/ |
jjhursey
approved these changes
Sep 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Signed-off-by: Jeff Squyres [email protected]