Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add how-to for deploying Slurm using both the CLI and a bundle #5

Merged
merged 5 commits into from
Jul 31, 2024

Conversation

NucciTheBoss
Copy link
Member

This PR adds the initial draft for how to deploy Slurm using both the Juju CLI and a bundle.

Misc.

  • Enabled sequential navigation within the doc site so that it is easier for readers to proceed through each howto as they walk through deploying their own Charmed HPC cluster.
  • Moved HPC specific terms to .custom_wordlist.txt since .wordlist.txt is directly from the documentation starter pack and should remain unmodified.

Page preview

image

- Starter pack recommends using .custom_wordlist for per-documentation modifications

Signed-off-by: Jason C. Nucciarone <[email protected]>
Signed-off-by: Jason C. Nucciarone <[email protected]>
Signed-off-by: Jason C. Nucciarone <[email protected]>
@NucciTheBoss
Copy link
Member Author

@jedel1043 thank you for the comments. General gist I'm getting is to omit the unnecessary. I'll wordsmith to make it more recipe-y like 🪨🔨

@NucciTheBoss
Copy link
Member Author

@jedel1043 R4R again. I simplified the sections that you highlighted and made things more dry, to-the-point. Let me know what you think of the revision!

Page preview

image

@NucciTheBoss NucciTheBoss requested a review from jedel1043 July 31, 2024 20:14
- Remove unnecessary details from different sections.
- Remove "Getting started" section.
- Make important `virt-type` info before deployment commands.
- Make blurb about Slurm being the only supported workload manager a note.
- Various grammar fixes.

Signed-off-by: Jason C. Nucciarone <[email protected]>
Copy link
Contributor

@jedel1043 jedel1043 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!

@NucciTheBoss
Copy link
Member Author

I'm happy with this! I'll merge. At some point after we have a good base doc set we'll want to get one of the technical authors to formally review what we've wrote, but for now we be zooming.

@NucciTheBoss NucciTheBoss merged commit cd8d8f0 into charmed-hpc:main Jul 31, 2024
1 check passed
@NucciTheBoss NucciTheBoss deleted the howto-deploy-slurm branch August 2, 2024 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants