Commit 84ab3104 authored by doc@bgerp.org's avatar doc@bgerp.org

p11862 Documentation.

parent 6b1d4121
...@@ -9,6 +9,7 @@ ...@@ -9,6 +9,7 @@
== Лог изменений == Лог изменений
[square] [square]
* <<project.adoc#longlife-branch, 16.02.2020>> Долгоживущие GIT ветки.
* <<project.adoc#, 10.02.2020>> Множество дополнений в описании проекта для разработчиков: архитектура, workflow, стек технологий. * <<project.adoc#, 10.02.2020>> Множество дополнений в описании проекта для разработчиков: архитектура, workflow, стек технологий.
* <<kernel/install.adoc#, 03.02.2020>> Уточнены настройки MySQL при установке. * <<kernel/install.adoc#, 03.02.2020>> Уточнены настройки MySQL при установке.
* <<project.adoc#ide-run, 26.01.2020>> Создание тестовой БД для разработчиков. * <<project.adoc#ide-run, 26.01.2020>> Создание тестовой БД для разработчиков.
......
...@@ -221,14 +221,14 @@ BGERP запускается в IDE, с подключением к удалён ...@@ -221,14 +221,14 @@ BGERP запускается в IDE, с подключением к удалён
|Изменение программы и документации. |Изменение программы и документации.
|<<test-unit-and-doc>> |<<test-unit-and-doc>>
|*documentation* |*p11862-documentation*
|master |master
|Корректировки документации. Долгоживущая ветка, периодически переносится на master. |Корректировки документации. <<longlife-branch, Долгоживущая ветка>>, периодически переносится на master.
|<<publish-doc>> |<<publish-doc>>
|*documentation-change-request* |*documentation-change-request*
|documentation |p11862-documentation
|Предложения по корректировке документации, могут быть смерджены обратно на documentation. |Предложения по корректировке документации, могут быть смерджены обратно на p11862-documentation.
|<<test-unit-and-doc>> |<<test-unit-and-doc>>
|=== |===
...@@ -290,16 +290,7 @@ git remote prune origin ...@@ -290,16 +290,7 @@ git remote prune origin
git fetch origin master:master git fetch origin master:master
---- ----
[[documentation]] [[accept]]
=== Документация
Исходные файлы в формате AsciiDoctor размещаются в каталоге *srcx/doc* проекта.
Модификация исходных кодов программы и документации выполняется одновременно в ветке <<workflow, изменения>>.
Примеры форматирования и рекомендации можно посмотреть <<samples.adoc#, здесь>>.
Документация может быть <<build-doc, собрана>> локально с ветки и <<build-update, включена>> в пакет обновления.
Публикация документации <<publish-doc, происводится>> с ветки <<workflow, ветке>> *documentation*.
Для предложения больших правок следует создать префиксом *documentation-*, начинающуюся с данной.
=== Приёмка и перенос === Приёмка и перенос
При принятии изменения производится сравнение ветки с основной. При принятии изменения производится сравнение ветки с основной.
Поэтому перед передачей изменения необходимо смерджить на ветку актуальное состояние основной. Поэтому перед передачей изменения необходимо смерджить на ветку актуальное состояние основной.
...@@ -326,6 +317,23 @@ git push ...@@ -326,6 +317,23 @@ git push
Периодически с основной ветки <<build-erp, публикуется обновление>>. Периодически с основной ветки <<build-erp, публикуется обновление>>.
[[longlife-branch]]
=== Долгоживущие ветки
В долгоживущих ветках производятся изменения *не влияющие на функциональность продукта*.
Как-то: корректировка локализации, документации, форматирование кода, тесты.
Процесс изменения при этом не закрывается, а <<accept, перенос>> производится многократно по мере готовности очередной порции изменений.
[[documentation]]
==== Документация
Частным случаем долгоживущей ветки является документация.
Исходные файлы в формате AsciiDoctor размещаются в каталоге *srcx/doc* проекта.
Модификация исходных кодов программы и документации выполняется одновременно в ветке <<workflow, изменения>>.
Примеры форматирования и рекомендации можно посмотреть <<samples.adoc#, здесь>>.
Документация может быть <<build-doc, собрана>> локально с ветки и <<build-update, включена>> в пакет обновления.
Публикация документации <<publish-doc, производится>> с ветки <<workflow, ветке>> *p11862-documentation*.
Для предложения правок документации следует создать ветку, начинающуюся с данной.
== Архитектура == Архитектура
BGERP представляет из себя standalone Java приложение с динамическим Web интерфейсом. BGERP представляет из себя standalone Java приложение с динамическим Web интерфейсом.
Запуск во время разработки может быть <<ide-run, произведён>> прямо в IDE. Запуск во время разработки может быть <<ide-run, произведён>> прямо в IDE.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment