Submitting first job tutorial

[jen-reeve]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @jen-reeve, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a substantial refactoring of the 'Submitting your first job' tutorial, transforming it from a comprehensive, standalone guide into a more concise overview that points to dedicated resources for in-depth information. The intent is to create a clearer learning path for users by centralizing detailed command explanations and reference material in appropriate cheat sheets and guides, while the tutorial focuses on the workflow.

Highlights

• Tutorial Refactoring: The 'Submitting your first job' tutorial has been significantly refactored, removing extensive content and replacing it with a high-level outline and links to other resources.
• Documentation Integration: The 'Slurm Reference Sheet' is now linked from the main 'Batch Computing Guide' and its description updated to reflect its role alongside the refactored tutorial.
• Streamlined Learning Path: The changes aim to provide a more streamlined learning experience by directing users to specialized documents for detailed information on Slurm commands and concepts.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

---

Old guide now made new,Links now lead to deeper lore,Learning finds its way.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[github-actions]

Test deployment available at https://callumwalley.github.io/mkdocs-demo-deploy/nesi/support-docs/first-job-tutorial

Seems the following pages differ;

• Batch_Computing_Guide
• Submitting_your_first_job
• Using_GPUs
• FORMAT
• VSCode
• Slurm-Reference_Sheet
• index
• NEWPAGE
• Bash_Shell
• Environment_And_Modules
• Parallel
• Resources
• Scaling
• Submitting_Your_First_Job
• What_is_an_HPC

See all deployed demo sites

[WesHarrell]

This looks good to me. Happy for this to replace previous pages

[jen-reeve]

Taking a poke through and adding notes here. 99% nitpicky stuff I'll fix at some point.

What is an HPC?

• - node image is WAYYY too bright
• - I like the first quiz
• - Keypoints admonition color is also too bright
• - NeSI in places still
• - some spots to add links to other pages in the docs (OnDemand jumped out at me)

Bash Shell

• - NeSI again
• - nn_storage_quota example shows the output but not the actual command which might be nice b/c I use it wrong all the time (-u versus -p)
• - Following paragraph mentions user being over quota but it isn't
• - home info admonition empty
• - workshop working dir comment
• - ls reading comprehension file tree image broken
• - inconsistent coloring of commands versus output (I like the color to indicate command use idea)
• - increase size of command structure image
• - do we have a plan for the question/solution admonitions?
• - tab completion first command is weird? Python issue?
• - any ideas on breaking this page up? it is a long one
• - cat mentioned but not in the table of other file operations
• - should we mention pipes? just in the context of cat?
• - too many keypoints

Environment and modules

• - why are the objectives in quotes?
• - change "Python 2 and 3 and C..." to be "Python 2 and Python 3 and C ...."
• - I think we can do something formatting-wise to make the software incompatibility/versioning/dependencies paragraphs nicer, something about them bugs me
• - remind me to just do a typo/nitpick edit at the end
• - the last page covered the structure of commands, but I don't think it mentioned subcommands, should we explain that more or just assume people can figure it out from context?
• - ok well now you are claiming that pipes are covered in intro to bash
• - do we want to cover searching for software and that module is case sensitive

Submitting your first job

• - we need to stick this R script somewhere (sum_matrix.r)
• - quizify

Resources

• - objectives in quotes
• - first code block has an extra set of ticks at the end
• - math formatting
• - mention /opt/nesi/examples?
• - test jobs paragraph stopped being real sentences
• - 'debug jobs have to run within 15 minutes' -> 'debug jobs cannot run for more than 15 minutes'

Scaling

• - objectives in quotes
• - I'm assuming this is currently missing most of the content

Parallel

• - the node image again
• - objectives in quotes

Other

• Resources and Parallel are missing their graduation caps!
• Adding a button to the homepage?
• What's going on with the link to the tutorial from the Batch Computing Guide? I'm assuming you are doing something fancy?