en_help.md

layout: page
title: Help
permalink: /help/
ref: help
lang: en

This page offers some first aid on the use of [JLU GitLab], but cannot replace the official user help, available at https://gitlab.test.uni-giessen.de/help/user/index.md. For specific information about JLU GitLab, see information.

How to use GitLab? {#how_to_gitlab}

TODO: Browser sufficient for many smaller things, for serious work you should install Git locally.

First steps {#first_steps}

TODO: Rough overview, links to good resources for learning more (see further help below).

Visibility of projects (and groups) {#visibility}

Every project has a visibility setting as either private, internal, or public. The visibility can only be changed by the Owner of the project (see user roles below).

Projects with private visibility are only visible to the members of the project, except for members with the Guest role.

Projects with internal visibility are visible to anyone with a user account who is logged in. In JLU GitLab, this means potentially any employee or student in the university with valid g- or s-login.

For more details, please refer to the official documentation{:target="_blank"}.

Like with projects, the visibility of groups can be set to private, internal, or public to allow access to explicitly selected users, all logged-in users, or anyone.

User roles and permissions {#user_roles}

TODO: Meanings of Guest through Owner.

If you include somebody as a project member, you have to decide what role they should have. You can pick either Guest, Reporter, Developer, Maintainer or Owner. Each role is associated with an increasing set of permissions, see also the official documentation{:target="_blank"}.

Project permissions as Guest {#role_guest}

The Guest role is for not-active members who can only read content, and open issues and leave comments.

Project members with the Guest role can download the project, leave comments, view and pull project files, view wiki pages, create new issues, see related issues, create confidential issues, and view self-created confidential issues.

If Public pipelines is enabled in Project Settings > CI/CD, they can also see a list of jobs, see a job log, and download and browse job artifacts.

Project permissions as Reporter {#role_reporter}

The Reporter role is for members who get more insights and can work in the issue tracker.

Project members with the Reporter role get the following permissions in addition to the Guest role: TODO

Project permissions as Developer {#role_developer}

TODO

Project permissions as Maintainer {#role_maintainer}

TODO

Project permissions as Owner {#role_owner}

TODO

User groups {#groups}

TODO: Group members and their roles and associated permissions. TODO: Clarification that group projects won't be deleted when leaving JLU, as long as members exist in the group.

Settings about private information {#private_info}

TODO: Setting of commit email address (in GitLab and locally), hiding of activity and profile, ...

Last steps {#last_steps}

TODO: Explanation when and what stuff gets deleted once you leave JLU (account data, own projects, ...) and what doesn't (group projects including issues and comments, commits, ...).

• Except for commits, stuff will be anonymized (transferred to the Ghost user).

Further help {#more_help}

TODO: Useful links, maybe in categories.