Skip to content

GitLab

Last edited by Fabian Nuraddin Alexander Gabel
Page history

Getting Started

Based on the German sketch by Fabian Gabel: https://writemd.rz.tuhh.de/s/bZESwieQR

Depending on your role in this repository (repo) you can either chose to contribute via

  • merge request or
  • Fork (not described here)

By default you don't have a role in this repo which means that you have to prepare your work in your own namespace. It is therefore recommended to request access to this repo by clicking on the respective link on the main page

image

The project administrator will then assign you Reporter, Developer or Maintainer status.

Merge-Request for Developers

We first give a quick intro to the philosophy of this approach and then show a step-by-step tutorial.

This approach follows the following philosophy

issue -> merge-request -> do-your-work -> mark-as-ready -> merge-to-dev -> merge-to-master

Interpretation:

  • Issue: You want to create a new research topic or have found a typo. Draw your ticket.(Issue)
  • merge-request: create the framework for offering your solution to the administrators.
  • merge-to-dev: via the merge-request so they can check your offering and integrate your contribution in the dev branch (quality assurance of content).
  • merge to master: if the first step of quality assurance was passed, the stability of the webpage is assessed before final publication on the web (quality assurance of web page logic)

Step-by-step Tutorial

1. Create an issue ...

... an thereby express you wish to change something or have something changed

2. Fill out description

What do you want to do? Keep it short.

  • Assign this issue to an Assignee (just choose yourself or leave it empty).
  • Choose a label, e.g. typo or research-topic. Choose a fitting one from the list of labels.
  • Finally, click Create Issue.

4. Create a merge request

  • Create the branch that you will be working on .
  • Stick to the default branch name and merge to dev (also default).

5.1 (Optional) Add missed labels

  • If you misssed out a label during issue creation, choose one now ( e.g. research-topic, or typo).

6. Now start working

  • Work on the branch 391-my-new-research locally oder directly in the repo. If creating a new file/research-topic, make sure to use a filename that is
  • matching your topics tile
  • using only lower case letters
  • now containing spaces (replace spaces by the underscore _

There are different ways to add and modify your files.

  • Gitlab Web IDE
  • basic uploading and editing on GitLab
  • using Online Markdown Editor and Copy&Paste.

Git users will know other ways.

GitLab Web IDE

  • Click Open in Web IDE: image
  • Navigate to the topics folder and create a new file.
  • The markdown files for the topics are to be found in the folder topics (s.a. Repository-Structure).
  • Save your changes with Commit.

image

  • You can start with one of the templates from the Styleguide.

Aternative: HedgeDoc

  • Use the online markdown editor HedgeDoc for immediate preview

hedgedoc

  • copy&and paste your worked out Markdown document in the repo using the OnlineIDE.
  • Export the .md file as above and upload it directly to your branch.

7. Finish drafting your merge request

  • Navigate to your merge request.
  • Wait for the pipeline to go through.
  • Check out the web page preview in the review app.
  • Mark your request as ready (Mark as ready button) and thereby notify the administration that your done.

8. Congratulations!

An administrator will now handle the merge request.

Questions?

Join the discussion in our Mattermost Helpdesk (E-10 members only)!