Git Advice for APS beam lines#

Beamline GitHub organizations#

Most beamlines will use GitHub to host their bluesky repositories. These are publicly-accessible (read-only) so do not place any content there that should not be publicly-accessible.

GitHub organizes repositories using this pattern: https://github.com/ORGANIZATION/REPOSITORY

ORGANIZATION is either a single user’s account or a named organizations (created by some GitHub user).

This naming convention is recommended for the beamline organization:

create a GitHub organization with a name like this : APS-SSS-GGG
SSS : sector, beamline, and station (such as 32IDC)
GGG : operating group (such as MIC for the XSD/Microscopy group)
Within each organization, create a repository : bluesky-INSTRUMENT
INSTRUMENT : the name of the sintrument, such as USAXS

APS GitLab#

When there is content that requires access restrictions (thus, not publicly-accessible), the APS GitLab server, managed by the APS IT group, is available to host that content. The server provides online help comparable to that provided by GitHub.

GitLab organizes repositories using this pattern: https://git.aps.anl.gov/ORGANIZATION/SUBGROUP/REPOSITORY

The SUBGROUP level is optional.

Guides#

This is a sampling of How-To guides explaining Git and GitHub repositories.