Это руководство, которое рассматривает разработку под Битрикс24 как фреймворк с учетом аспектов применения его в законченном продукте. Целью данного руководства является:
- Систематизация знаний в области API Битрикс24
- Упрощение изучения платформы для новых разработчиков
Руководство не ставит цели заменить существующие курсы связанные с Битрикс24 и платформой Bitrix Framework, но стараемся дополнить их актуальной информацией которая поможет в работе. Мы надеемся что каждый специалист найдет в ней что-то полезное.
Существует несколько способов принять участие в разработке документации:
- В issue писать недостающе темы
- Проводить review, исправть орфографические и другие ошибки
- Писать статьи
Все способы перечислены от наименьшего к наибольшему вкладу, мы будем благодарны за любой вклад.
Файлы руководства описаны в формате Markdown. Прежде чем приступать к написанию документации ознакомьтесь с наиболее популярной спецификацией - GitHub Flavored Markdown Spec.
Для генерации документации мы используем Daux.io, который потребуется установить на ПК для визуального осмотра документации Требования:
- PHP 7.2+
- Установленные модули:
- php-mbstring
- php-xml
- php-intl
Вам потребуется форкнуть репозиторий для работы над ним. Мы радеем за качество документации, поэтому не можем давать доступ на запись всем подряд. Работа по изменению ведется исключительно через merge request.
Когда ваше творческая деятельность закончена, необходимо провести визуальную проверку. Перейдите в корень проекта и выполните комманду
daux generate`На выходе в директории static будет сгенерирована документация. Проверьте ее визуально, при необходимости внесите исправления и повторите этот шаг.
В случае если все хорошо, выполните merge request в нашу документацию.