|
|
| (не показаны 3 промежуточные версии 1 участника) |
| Строка 1: |
Строка 1: |
| '''Справочная документация''' - для Веб-ЛИМС "Тритея" представляет собой связанный набор HTML-страниц, размещенных по ссылкам: | | '''Справочная документация''' - для <code>Веб-ЛИМС "Тритея"</code> представляет собой связанный набор HTML-страниц, размещенных на демо-стендах по ссылкам: |
| *https://triteia.chemsoft.ru/doc | | *https://triteia.chemsoft.ru/doc |
| *https://astra.chemsoft.ru/doc | | *https://astra.chemsoft.ru/doc |
| | |
| | Так же данная документация упаковывается в docker-контейнер (дистрибутив) для дальнейшей передачи наработок Пользователям. |
|
| |
|
| ==Этапы документирования Веб-ЛИМС== | | ==Этапы документирования Веб-ЛИМС== |
| Строка 8: |
Строка 10: |
|
| |
|
| ===[[Формирование и актуализация Markdown-исходников документации|2. Формирование и актуализация Markdown-исходников документации]]=== | | ===[[Формирование и актуализация Markdown-исходников документации|2. Формирование и актуализация Markdown-исходников документации]]=== |
| | |
| ===[[Фиксация изменений и отправка в удаленный репозиторий GitLab|3. Фиксация изменений и отправка в удаленный репозиторий GitLab]]=== | | ===[[Фиксация изменений и отправка в удаленный репозиторий GitLab|3. Фиксация изменений и отправка в удаленный репозиторий GitLab]]=== |
| | |
| ===[[Проверка и утверждение изменений в Merge Request|4. Проверка и утверждение изменений в Merge Request]]=== | | ===[[Проверка и утверждение изменений в Merge Request|4. Проверка и утверждение изменений в Merge Request]]=== |
| ===[[Автоматическая генерация HTML-страниц и обновление сайта|5. Автоматическая генерация 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
| |
|
| |
| Справочник состоит из оглавления в левой части интерфейса, и контента справа, отображающего содержимое выбранной главы.
| |
|
| |
|
| Для удобства работы пользователя доступны функции навигации, поиска и смены цветовой темы.
| | ===[[Автоматическая генерация HTML-страниц и обновление сайта|5. Автоматическая генерация HTML-страниц и обновление стендов]]=== |
