Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
B
bgerp
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Incidents
Environments
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
pub
bgerp
bgerp
Commits
84ab3104
Commit
84ab3104
authored
Feb 16, 2020
by
doc@bgerp.org
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
p11862 Documentation.
parent
6b1d4121
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
23 additions
and
14 deletions
+23
-14
srcx/doc/changes.adoc
srcx/doc/changes.adoc
+1
-0
srcx/doc/project.adoc
srcx/doc/project.adoc
+22
-14
No files found.
srcx/doc/changes.adoc
View file @
84ab3104
...
...
@@ -9,6 +9,7 @@
== Лог изменений
[square]
* <<project.adoc#longlife-branch, 16.02.2020>> Долгоживущие GIT ветки.
* <<project.adoc#, 10.02.2020>> Множество дополнений в описании проекта для разработчиков: архитектура, workflow, стек технологий.
* <<kernel/install.adoc#, 03.02.2020>> Уточнены настройки MySQL при установке.
* <<project.adoc#ide-run, 26.01.2020>> Создание тестовой БД для разработчиков.
...
...
srcx/doc/project.adoc
View file @
84ab3104
...
...
@@ -221,14 +221,14 @@ BGERP запускается в IDE, с подключением к удалён
|Изменение программы и документации.
|<<test-unit-and-doc>>
|*documentation*
|*
p11862-
documentation*
|master
|Корректировки документации.
Долгоживущая ветка
, периодически переносится на master.
|Корректировки документации.
<<longlife-branch, Долгоживущая ветка>>
, периодически переносится на master.
|<<publish-doc>>
|*documentation-change-request*
|documentation
|Предложения по корректировке документации, могут быть смерджены обратно на documentation.
|
p11862-
documentation
|Предложения по корректировке документации, могут быть смерджены обратно на
p11862-
documentation.
|<<test-unit-and-doc>>
|===
...
...
@@ -290,16 +290,7 @@ git remote prune origin
git fetch origin master:master
----
[[documentation]]
=== Документация
Исходные файлы в формате AsciiDoctor размещаются в каталоге *srcx/doc* проекта.
Модификация исходных кодов программы и документации выполняется одновременно в ветке <<workflow, изменения>>.
Примеры форматирования и рекомендации можно посмотреть <<samples.adoc#, здесь>>.
Документация может быть <<build-doc, собрана>> локально с ветки и <<build-update, включена>> в пакет обновления.
Публикация документации <<publish-doc, происводится>> с ветки <<workflow, ветке>> *documentation*.
Для предложения больших правок следует создать префиксом *documentation-*, начинающуюся с данной.
[[accept]]
=== Приёмка и перенос
При принятии изменения производится сравнение ветки с основной.
Поэтому перед передачей изменения необходимо смерджить на ветку актуальное состояние основной.
...
...
@@ -326,6 +317,23 @@ git push
Периодически с основной ветки <<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 интерфейсом.
Запуск во время разработки может быть <<ide-run, произведён>> прямо в IDE.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment