Работа с сервисом Gitlab¶

Для обеспечения хранения и онлайн редактирования документации используется сервис Gitlab.

Gitlab - интернет сервис для хранения файлов работающих под какой либо системой контроля версий(от англ. Version Control System, VCS или Revision Control System). В нашем случае используется Git.

Удобства сервиса Gitlab ¶

Удаленное хранение документации в конфиденциальном виде;
Онлайн доступ для пользователей;
Удобство онлаин наполнения с возможностью предпросмотра результата;
Автоотправка изменений к на сервер для сборки в более удобном для чтения виде для наших партнеров;

Удобства систмы Git ¶

Возможность одновременной работы нескольких пользователей над документацией без потери изменений;
Возможность иметь несколько разных версий документации в одной файловой стстеме (ветвление в Git);
Хранение истории всех изменений в документации;
Возможность восстановить лбоей состояние документации из истории.

Использование Gitlab ¶

!!! Для доступа к редактированию документации обратитесь к техническому директору.

Все работы с документацией ведутся в папке /source данного репозитория.

Просомтр документации доступен по этой ссылке.

Перейти к редактированию выбранной страницы можно:

со страницы документации нажав на ссылку в верхней части страницы от куда вы попадете на страницу редактирования на Gitlab

просто найти необходимую страницу на Gitlab

Перед началом наполнения отдельного документа ознакомьтесь с синтаксисом Markdown который находится вот тут

Основные элементы ¶

Страница на сервисе Gitlab можно условно разделить на 3 основные части:

Шапка;
Сайдбар;
Основной контент.

Шапка ¶

В шапке размещено меню для управления вашим аккаунтом.

Служит для личных настроек и переключения между доступными проектами.

Сайдбар ¶

Меню управления проектом.

Основной контент ¶

Основной блок в котором можно переходить по каталогам документации, а так же редактировать отдельные документы.

Переход к редактированию документа ¶

Для редактирвания документа находясь на сервисе можно:

открыть главную страницу проекта;
или в сайдбаре сервиса перейти в пункт Repository.

Далее в блоке с основным контентом, зайти в папку source и выбрать нужную вам папку/файл который вы хотите отредактировать.

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

Нажимаем кнопку Edit и переходим к редактированию файла.

Режим редактирования файла;
Предпросмотр отредактированного файла;
Название Git-ветки в которой находится текущий файл;
Путь к файлу;
Область для редактирования/просмотра содержимого;
Комментарий к изменению;
Название Git-ветки в которую будут сохранены изменения;
Кнопка сохранения изменений;
Кнопка отмены изменений.

Git-ветвление ¶

в разработке