Celesta 7: документация переехала на AsciiDoc в модуль celesta-documentation

5 views
Skip to first unread message

Ivan Ponomarev

unread,
Nov 4, 2018, 9:36:20 AM11/4/18
to curs-group

Всем привет,

информирую о том, что документация по Celesta 7 теперь ведётся на AsciiDoctor и переехала в модуль celesta-documentation проекта Celesta (https://github.com/CourseOrchestra/celesta/tree/dev/celesta-documentation). Для внесения изменений в документацию теперь необходимо вносить изменения в .adoc-файлы и делать pull-request. Сборка HTML-версии документации является частью сборки Celesta, она будет падать (и PR не будет согласован на merge) в случае ошибок в AsciiDoctor-коде, таких как незакрытые тэги или невалидные внутренние ссылки.

В вики документация по Celesta 7 больше не ведётся. В вики продолжает вестись документация по Celesta 6 ('Jyhon-версия').


Сборка осуществляется в формате HTML в файл celesta-documentation...zip (см. напр. https://artifactory.corchestra.ru/artifactory/list/libs-release-local/ru/curs/celesta-documentation/7.0.7/celesta-documentation-7.0.7-documentation.zip). В ближайшее время мы решим вопрос с автоматическим выкладыванием документации по Celesta в web.

Внимание всем разработчикам Celesta.

Теперь каждый PR в Celesta, изменяющий/дополняющий функциональность, должен также в себе содержать релевантные изменения в коде модуля celesta-documentation. Это упростит нам процесс разработки (раньше доработка документации была оторвана от изменений в коде) и в целом решит задачу выдачи индивидуальной версии документации под каждую из версий Celesta.

С уважением,

ИП

Ivan Ponomarev

unread,
Nov 4, 2018, 6:13:05 PM11/4/18
to curs-group
В дополнение к предыдущей новости:

актуальная документация на Celesta 7 автоматически выкладывается здесь:

https://courseorchestra.github.io/celesta/

04.11.2018 17:36, 'Ivan Ponomarev' via curs-group пишет:
--
Вы получили это сообщение, поскольку подписаны на группу "curs-group".
Чтобы отменить подписку на эту группу и больше не получать от нее сообщения, отправьте письмо на электронный адрес curs-group+...@googlegroups.com.
Чтобы отправлять сообщения в эту группу, отправьте письмо на электронный адрес curs-...@googlegroups.com.
Чтобы зайти в группу, перейдите по ссылке https://groups.google.com/group/curs-group.
Чтобы посмотреть обсуждение на веб-странице, перейдите по ссылке https://groups.google.com/d/msgid/curs-group/bb6d4843-a215-9e16-d03b-0689484dcff0%40mail.ru.
Чтобы настроить другие параметры, перейдите по ссылке https://groups.google.com/d/optout.


Reply all
Reply to author
Forward
0 new messages