DOC: darshan-runtime user guide in markdown format #1030
Closed
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
|
This looks great to me @wkliao , thanks for finding this option and trying it out. Lets follow up a little offline. |
Collaborator
Author
|
Close this PR, as we have decided to go with the option of readthedocs (#1034) |
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.
To move away from using mcs web server to host Darshan's documents, one
way is to use markdown format. Luckily, both Darshan runtime and util guides
are currently in txt format. It does not take too much effort to convert.
An md file can be directly viewed from the github repo or saved in its wiki page.
See it in darshan-runtime.md
This PR is the first attempt on darshan-runtime guide.
If it looks fine, we can move on to other user guides.