Gitlab Wiki

gitlab wiki — документация, которую можно вести для каждого проекта. Обычно это системные требования, описание пакетов и процесса установки.

gitlab wiki — документация проектов

После добавления проекта в меню слева доступен раздел Wiki. В нем модно добавить неограниченное количество страниц с текстовыми материалами. Wiki специфична для проекта.

Первой всегда добавляется главная страница Home.

gitlab wiki

Стандартным способом оформления является Markdown. Доступен режим Preview в котором видно как будет выглядеть текст.

В примере добавление заголовка h1 и выделение для команды python3 index.py

Чуть ниже показано как создать ссылку, ее текст указывается в скобках, сама ссылка — в квадратных скобках. Пока оставляем их пустыми и нажимаем New Page. Позже в квадратных скобках будет адрес второй страницы.

Title можно оставить «how to setup». Далее содержимое в том же формате. Здесь это список.

gitlab wiki3

При выборе Preview.

gitlab wiki4

Теперь можно скопировать URL второй страницы и указать его как ссылку на первой.

В результате получилась минимальная Wiki с описанием тестового приложения. Также есть системные требования и указания по установке.

gitlab wiki5

Wiki могут существовать для проектов, находящихся в общем доступе и для приватных репозиториев. Подробную документацию всегда стоит вести, это позволит удобно работать с проектом всем, кому это требуется.

Читайте про запуск тестов в Gitlab.