Работа со справочной документацией
Справочная документация - для Веб-ЛИМС "Тритея" представляет собой связанный набор HTML-страниц, размещенных по ссылкам:
Этапы документирования Веб-ЛИМС
Проверка и утверждение изменений в Merge Request
Если внесённые изменения находятся в отдельной ветке GIT, они должны быть добавлены в одну единственную, главную ветку (обычно main), в которой находится вся остальная документация.
Для этого необходимо выполнить следующее:
Зайти на страницу с репозиторием, в данном случае https://gitlab.chemsoft.ru/chemic3-group/chemsoft-docs-content Создать запрос на слияние (merge request) одним из двух способов: через вкладку Merge requests в боковом меню слева с помощью кнопки, появляющейся в верхней части окна после внесения изменений на gitlab При первом способе после нажатия на вкладку Merge requests в разделе Code левого бокового меню происходит перенаправление на страницу, где нужно нажать на кнопку New merge request 32 33 После этого происходит перенаправление ещё на одну страницу, где необходимо указать ветку с изменениями (Source branch - слева) и ветку для слияния (Target branch - справа), и нажать на кнопку Compare branches and continue
34 На следующей странице необходимо настроить запрос на слияние, а именно:
Указать заголовок merge request Добавить описание merge request Назначить ответственного Назначить проверяющего Нажать кнопку Create merge request 36 При втором способе после нажатия кнопки Create Merge Request проделываются шаги 1-5, описанные выше. 37
На странице запроса на слияния происходит подтверждение слияния с веткой проверяющим нажатием на кнопку Merge При этом есть возможность для просмотреть изменения, и оставить комментарий (замечания) к запросу.
Сообщение Ready to merge! означает что конфликты между ветками отсутствуют и они готовы к слиянию. Если возникают конфликты, вместо этого сообщения будет соответствующее предупреждающее сообщение. В этом случае необходимо разрешить конфликты следуя пунктам 3.1.1.1, 3.1.1.2, 3.1.1.3 и опубликовать рабочую ветвь без конфликтов (п.3.3, 3.4), после чего вернуться к запросу на слияние на gitlab и убедиться в готовности к слиянию.
Так же при слиянии существуют дополнительные действия:
Delete source branch - удаление рабочей ветки Squash commits - Объединение коммитов в один Edit commit message - Редактирование сообщения к коммиту 38
Автоматическая генерация HTML-страниц и обновление сайта
После подтверждения merge request автоматически генерируется пакет с WEB страницами, включающие все последние изменения репозитория и публикует по адресам:
https://astra.chemsoft.ru/doc https://triteia.chemsoft.ru/doc
Пример сформированного документа:
1
Справочник состоит из оглавления в левой части интерфейса, и контента справа, отображающего содержимое выбранной главы.
Для удобства работы пользователя доступны функции навигации, поиска и смены цветовой темы.