Использование gitlab
Документация хранится в системе контроля версий git - https://gitlab.edu.nstu.ru/ido/documentation. Ниже приведена инструкция как вносить изменения в документацию используя интерфейс gitlab.
Блок про логин/регистрацию
Если не зарегистрированы - обратиться к Колесникову Алексею (а лучше список из нас троих)
Работа с файлами
Для внесения изменений в файлы необходимо использовать веб редактор. Перейдите на страницу проекта по адресу https://gitlab.edu.nstu.ru/ido/documentation и нажмите на кнопку "Web IDE" (отмечена на скрине ниже) - откроется новая страница с редактором.
На скрине ниже - редактор, основные элементы управления:
- Диспетчер файлов. В этой области можно раскрывать папки и выбирать файл, который хотите отредактировать
- Редактор файлов. В этой области можно изменять текст
Файлы не сохраняются автоматически, их необходимо сохранять вручную. Для этого есть дополнительные области, переключаться между которыми можно с помощью кнопок (на скрине ниже):
- Включает область редактора (описан выше)
- Просмотр внесенных изменений по всем файлам. В рамках решаемых задач данная вкладка не актуальна
- Сохранение внесенных изменений, описание областей смотрите ниже
При переходе на третью вкладку открывается сохранение внесенных изменений. За один раз можно сохранить изменения в нескольких файлах. Элементы управления:
- Список файлов изменениями.
- Просмотр внесенных изменений. Слева вариант без изменений (как было до редактирования), справа - итоговый вариант, который будет сохранён. Красным отмечены строки которые будут удалены, зелёным - добавленные строки.
- Кнопка сохранения изменений. О работе с ней ниже.
После нажатия на кнопку Create commit развернется блок сохранения. Обратите внимание, что выбран пункт Commit to main branch - при сохранении нужно делать именно так. Выше есть область для введения сообщения о причинах изменения. Хорошим тоном считается написать короткое сообщение с указанием, что было сделано и для чего.
После того, как написано сообщение и выбран правильный пункт куда сохранять, нужно нажать кнопку Commit. Изменения сохранятся
