Skip to content

Submitting first job tutorial#1074

Draft
jen-reeve wants to merge 75 commits intomainfrom
first-job-tutorial
Draft

Submitting first job tutorial#1074
jen-reeve wants to merge 75 commits intomainfrom
first-job-tutorial

Conversation

@jen-reeve
Copy link
Contributor

No description provided.

@jen-reeve jen-reeve self-assigned this Jan 7, 2026
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @jen-reeve, I'm Gemini Code Assist1! 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
Copy link
Contributor

github-actions bot commented Jan 7, 2026

@jen-reeve jen-reeve linked an issue Jan 11, 2026 that may be closed by this pull request
Copy link
Collaborator

@WesHarrell WesHarrell left a comment

Choose a reason for hiding this comment

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

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

@jen-reeve jen-reeve linked an issue Jan 14, 2026 that may be closed by this pull request
@CallumWalley
Copy link
Member

/gemini review

Copy link
Contributor

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

Choose a reason for hiding this comment

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

Code Review

The pull request introduces a new 'Tutorials' section to the documentation, including new pages for 'Introduction To HPC' covering Bash Shell, Environment & Modules, Parallel Computing, Resources, Scaling, and Submitting Your First Job. It also adds new admonition types (time, objectives, keypoints, next) and a quiz plugin for tutorials, along with corresponding CSS styling. Several existing documentation links were updated to point to the new tutorial pages. Review comments highlighted issues such as incorrect CSS syntax for background-color in theme.css, a missing sum_matrix.r file for an example script in the 'Submitting Your First Job' tutorial, and pedagogical ordering concerns in the 'Bash Shell' tutorial where relative paths are used before being explained. Inconsistencies were noted in example commands for node names and glob patterns in the 'Bash Shell' and 'Resources' tutorials. Additionally, there were several minor content issues including incomplete TODOs, an empty line in a code block, and incorrect admonition types (postrequisite instead of next) in the new tutorial pages.

Note: Security Review did not run due to the size of the PR.

nano example_job.sh
```

<!-- TODO: change this script to not require another file -->
Copy link
Contributor

Choose a reason for hiding this comment

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

high

A script that needs another file, but ye don't provide it? That's like givin' a man a musket with no powder! This tutorial will sink faster than a lead-lined longboat. Provide the sum_matrix.r file or change the example to somethin' that works on its own.


## Creating directories

<!-- NOTE: This bit uses relative paths even though the concept hasn't been introduced yet. -->
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

Avast! Ye be teachin' the greenhorns to navigate by the stars before they even know what a compass is! Explainin' relative paths after ye use 'em is a fine recipe for gettin' lost at sea. A bit of order in yer teachin' wouldn't go amiss.

`?` is also a wildcard, but it matches exactly one character. So the command:

```sh
ls !!!?.*
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

By the powers! !!!?.*? What kind of devil's gibberish is that for a glob pattern? It'll match nothin' ye intend. Ye'd have better luck findin' treasure with a blind parrot. Use a proper pattern, lest ye confuse the poor souls followin' this map.

Suggested change
ls !!!?.*
ls ????.*

mkdocs.yml Outdated
slurm: slurm-25.05.6
project_code: nesi99991
working_directory: ["nesi", "nobackup", "nesi99991", "introhpc2603"]
example_script: "example script"
Copy link
Contributor

Choose a reason for hiding this comment

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

low

A filename with a space? 'example script'? The style guide says to use underscores, ye bilge rat! It's a small thing, but discipline is what keeps a ship afloat. Best to follow the code.

  example_script: "example_script"

CallumWalley and others added 13 commits March 11, 2026 15:05
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Cal <35017184+CallumWalley@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Cal <35017184+CallumWalley@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Cal <35017184+CallumWalley@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Cal <35017184+CallumWalley@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Cal <35017184+CallumWalley@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Cal <35017184+CallumWalley@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Cal <35017184+CallumWalley@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Cal <35017184+CallumWalley@users.noreply.github.com>
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.

Scheduler episode Incorporate HPC Intro workshop materials into docs

3 participants