Мы благодарны всем, кто вносит изменения и дополняет документацию. Ваш опыт работы с REST API Битрикс24 помогает начинающим разработчикам познакомиться с API, а опытным — находить ответы на вопросы.
Документация по REST API Битрикс24 — это проект из файлов в формате Markdown и файлов Yaml, необходимых для управления структурой и навигацией.
Markdown удобен для технической документации и привычен многим разработчикам. Даже если вы ни разу его не использовали, то, ориентируясь на содержимое текущей документации, вы сможете быстро разобраться.
Итоговая документация генерируется из md/yaml-файлов в статичные html-файлы и автоматически публикуется.
Мы полагаем, что вы уже знакомы с принципами работы в системах контроля версий.
В репозитории есть основная ветка main для автоматической сборки документации. Права на работу с этой веткой есть только у редакторов документации.
Остальные контрибьюторы могут создавать свои ветки и вносить изменения в них. Затем отправлять их на проверку с помощью заявок pull request.
В правой верхней части каждой статьи документации есть кнопка редактирования.
![Редактирование статьи](./_images/edit-button.png "Редактирование статьи" =30x29)
Переход по ссылке откроет в репозитории статью, которую вы планируете изменить.
- В навигационном меню репозитория выберите вкладку Code.
- В правом верхнем углу окна файла нажмите кнопку Edit this file (иконка карандаша).
- Внесите необходимые изменения в текстовом редакторе прямо в браузере.
- GitHub предложит автоматически создать форк репозитория. Выберите эту опцию, чтобы создать форк.
- После внесения изменений прокрутите страницу вниз до раздела Propose changes.
- Введите заголовок и описание изменений: что вы изменили и почему.
- Нажмите кнопку Propose changes.
- Вас перенаправят на страницу создания pull request.
- На странице создания pull request нажмите Create pull request.
- Ваша заявка на изменение придет редакторам документации. Мы стараемся оперативно рассматривать предложенные заявки.
Вы можете добавить свою статью в документацию.
- Перейдите в репозиторий документации.
- Перейдите в раздел, в котором вы хотите предложить добавить статью.
- В правом верхнем углу списка файлов нажмите кнопку Add file.
- Выберите Create new file.
- Введите имя файла в поле Name your file. Файл со статьей должен иметь расширение md.
- В текстовом редакторе ниже добавьте содержимое нового файла.
- GitHub предложит автоматически создать форк репозитория. Выберите эту опцию, чтобы создать форк.
- После внесения изменений прокрутите страницу вниз до раздела Propose new file.
- Введите заголовок и описание: какой файл вы добавляете и почему.
- Нажмите Propose new file.
- Вас перенаправят на страницу создания pull request.
- На странице создания pull request нажмите Create pull request.
- Ваша заявка на изменение придет редакторам документации. Мы стараемся оперативно рассматривать предложенные заявки.