Skip to content

Create a real "quick start guide" (CSC-2892) #28

@alex-rosenberg35

Description

@alex-rosenberg35

The current "quick start guide" page is not really a quick start guide, but more of an orientation document or a combination of application instructions, access requirements, policy overview, and basic infrastructure information for new users.

We need a true quick start guide to quickly get users connected and using the cluster. The quick start guide should be actionable, practical, and minimal. E.g. “Here’s how to log in, run your first job, and check results.” It should only provide the bare minimum to get someone from “zero” to “something working”, with terminal commands, basic job submission info, and maybe one or two links for “dig deeper here.” You can assume the user already has access.

A true quick start guide might provide:

  • SSH login instructions
  • A minimal module load
  • A “Hello world” script for sbatch
  • Basic commands to check job status
  • How to transfer a file in/out
  • Where to go next

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions