docs: add README and fix charmcraft.yaml links #11
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
NucciTheBoss
requested changes
Aug 8, 2024
There was a problem hiding this comment.
Couple comments. Most of them pertain to adapting the old READMEs we had for the Slurm charms to the new README template we have for the charmed-hpc/docs repository. All we really need to do is massage the current contents into the template we have for the docs repo. Also, we should add a "What's next" section that directs folks to the documentation website.
Also, it should be Slurm instead of SLURM. I provided more context in one of my review comments, but TL;DR is that SLURM is the old way for referring to the Slurm workload manager 😅
Let me know if you have any thoughts and/or questions!
jedel1043
force-pushed
the
doc-enhancements
branch
2 times, most recently
from
7b80b66 to
2d68479
Compare
NucciTheBoss
requested changes
Aug 8, 2024
jedel1043
force-pushed
the
doc-enhancements
branch
from
2d68479 to
a68826b
Compare
jedel1043
force-pushed
the
doc-enhancements
branch
from
a68826b to
018f7a0
Compare
NucciTheBoss
approved these changes
Aug 9, 2024
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 should make charmhub.io link to this repo instead of the old ones.