fix: update existing docs to use code blocks instead of terminal blocks#126
Open
NucciTheBoss wants to merge 3 commits intocharmed-hpc:mainfrom
Open
fix: update existing docs to use code blocks instead of terminal blocks#126NucciTheBoss wants to merge 3 commits intocharmed-hpc:mainfrom
NucciTheBoss wants to merge 3 commits intocharmed-hpc:mainfrom
Conversation
Other changes: - Fix inconsistencies in list bulletings Signed-off-by: Jason C. Nucciarone <nuccitheboss@ubuntu.com>
… blocks Signed-off-by: Jason C. Nucciarone <nuccitheboss@ubuntu.com>
Other changes: - Updated the content to be more inline with our current docs. Signed-off-by: Jason C. Nucciarone <nuccitheboss@ubuntu.com>
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.
Pre-submission checklist
Summary of Changes
This PR updates our existing documentation to use code blocks instead of terminal blocks where appropriate. The updated documentation includes:
I also fixed some formatting inconsistencies that I found in the tutorial, and I updated the "Cleanup Slurm" how-to be more terse. I also fixed some comma splices that I found in the "Cleanup Slurm" how-to.
Also, for the tutorial, I updated some section to be more explicit about the Juju command(s) that will be used. I also removed the "Get compute nodes ready for jobs" section since
node-configuredwill no longer exist soon, and we can use thedefault-node-stateoption at deployment time.Related Issues, PRs, and Discussions