Skip to content

Update to docs for slurm composer to take into acount load or create …#1317

Draft
geoffreyweal wants to merge 1 commit into
mainfrom
slurm-composer
Draft

Update to docs for slurm composer to take into acount load or create …#1317
geoffreyweal wants to merge 1 commit into
mainfrom
slurm-composer

Conversation

@geoffreyweal

@geoffreyweal geoffreyweal commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Update to docs for slurm composer to take into acount load or create script from disk button

@github-actions

github-actions Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Test deployment successful!! (2026-06-23T11:39:25Z)
Preview available at https://callumwalley.github.io/mkdocs-demo-deploy/nesi/support-docs/slurm-composer

Seems the following pages differ;



See all deployed demo sites

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

Ahoy! This patch updates the Slurm Composer documentation to show landlubbers how to load or create scripts from disk. While the new directions are mostly clear, the crew spotted some sloppy writing that needs a good swabbing. We've got hyphenated 'dot-files' that should be 'dotfiles', some bloated phrasing like 'are shown greyed-out' that's wasting our ink, choppy double em-dashes making us seasick, and a self-filling form that sounds like black magic instead of proper English. Fix these grammar leaks before we toss this PR to the sharks!

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

It works much like the OnDemand **Files** app:

- **Navigate** by clicking folders, the breadcrumb trail, the **Home** and **Up** buttons, or by typing a path straight into the path box. **Refresh** re-reads the current folder, and your browser's Back/Forward buttons step through the folders you have visited.
- **Sort** by clicking the **Name**, **Size** or **Modified** headings; **Filter** the list by typing in the filter box; and tick **Show hidden** to include dot-files or **Owner & mode** to show each entry's owner and permissions.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

low

Avast, matey! Ye wrote 'dot-files' with a hyphen on line 103. Are ye trying to slice them poor files in twain? Standard sea-faring folk write it as 'dotfiles' without the anchor of a hyphen. Let's keep yer spelling clean and shipshape, shall we?


### Load an existing script

Click a `.sl`, `.sh`, `.sbatch`, `.batch` or `.slurm` file to open it in the Slurm script editor, where you can review, edit and submit it — or save it as a custom template. Files that are not scripts are shown greyed-out and cannot be selected.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

low

Ahoy! 'are shown greyed-out' is a bit of a mouthful, don't ye think? 'are greyed out' is much more direct and saves us some precious ink. We wouldn't want to waste our gunpowder on extra words!


### Create a new script

Click **New Script** to start a new one. This opens a template picker listing every template — with **Job Script (Slurm)** and **GPU Job Script (Slurm)** at the top — which you can narrow with the search box.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

low

Shiver me timbers! Those double em-dashes on line 111 are making me seasick! It reads like a choppy sea. Why not use parentheses to tuck away that extra detail about the job scripts, so the sentence flows as smooth as a calm bay? Or is a bumpy ride what ye intended for our readers?


![Choosing a template for a new script](../../../assets/images/Slurm_Composer_new_script.png)

Pick a template and its form opens ready to fill in, with the **Script location** already set to the folder you were browsing.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

low

Blimey! 'its form opens ready to fill in' sounds like the form itself is going to grab a quill and do the filling! Unless the form has gained a mind of its own, ye might want to say 'ready to be filled in' or 'ready for ye to fill in'. Let's not confuse the landlubbers.

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.

1 participant