Skip to content

Latest commit

 

History

History
111 lines (80 loc) · 4.35 KB

CONTRIBUTING.md

File metadata and controls

111 lines (80 loc) · 4.35 KB

Contributing

Thanks for considering to contribute and reading this!

Here we discuss how to contribute

Spoken text

Spoken text are ideas, feedback, messages, etc. and are written in English.

For ideas or feedback, create an Issue. These Issues will be discussed in a meeting and/or below that Issue.

Ideas that improve the experience of UPPMAX users trying to use our resources will likely be accepted.

Code

We welcome any contribution that:

  • improves the experience of UPPMAX users trying to use our resources
  • follow all standards set by the continuous integration tools (e.g. use 4 spaces for indentation)
  • puts the files in reasonable folders (see Where to put files? below)

As an UPPMAX contributor, one can contribute by:

  1. Clone this repository
  2. Add a branch
  3. Work on your branch
  4. When done, create a Pull Request from your branch to main
  5. If the change is accepted after review it will be merged into the main branch
  6. Your branch will be deleted after merging

As an external contributor, one can contribute by:

  1. Fork this repository
  2. Modify your Fork
  3. When done, creating a Pull Request from your Fork to this repository, merging to the main branch is fine :-)
  4. If the change is accepted after review it will be merged into the main branch

Where to put a new page: here or at https://www.uu.se/en/centre/uppmax?

It has been decided upon that, as a general rule, information should be on SiteVision until a user applies to a project. This means that information about applying for a project and using our clusters should be on this repository.

It has been decided upon too to try hard for minimal duplication.

Specific points that have been decided upon:

What Where
Applying for an account Here
Applying for NAISS projects Here
Applying for a local project Here
PUBA Here
Services offered through UIT [1] Here
Log in to each cluster Here
General description of hardware SiteVision
Detailed Hardware (e.g. how to access) Here
System usage Link from both
List of UPPMAX courses SiteVision
Course pages Here
Course registrations Investigate first
Support Keep things as they are
  • [1] If such a page is needed

Where to put files

All files are put in docs or docs/[some_folder], but not not deeper than that.

Description Where Typical name
Information about clusters cluster_guides bianca.md, rackham.md, snowy.md
Information about Slurm cluster_guides slurm.md
Information about general cluster processes cluster_guides [general_process_name].md
Cluster-specific information about Slurm cluster_guides slurm_on_bianca.md, slurm_[something].md
Cluster-specific information for software, except Slurm software [x]_on_bianca.md, rackham_do_something_with_[x].md
Software in general, except Slurm software [name of program].md

Examples on file transfer:

  • software/bianca_file_transfer_using_rsync.md
  • software/rsync.md
  • cluster_guides/file_transfer.md

Examples on job scheduler:

  • cluster_guides/slurm_on_bianca.md
  • software/squeue.md
  • software/sbatch.md
  • cluster_guides/slurm.md

Examples on general software use:

  • software/gcc.md (a collection of programs is software)
  • software/gcc_compile_c.md (same for all clusters)

Which branch

Submitting to the main branch is fine! Thanks!