Kaiten

Документация и инструкции

Log in

Как опубликовать дополнение в общем каталоге Kaiten

Дополнения расширяют возможности Kaiten: добавляют новые функции и связывают систему с другими сервисами. Разработчик может создать дополнение для своей компании, а затем отправить его на публикацию в общий каталог. После проверки и одобрения команды Kaiten оно станет доступно другим компаниям.

Как отправить дополнение на проверку

Отправлять дополнение на проверку могут пользователи с правом «Управление дополнениями в портале разработчиков». Выдать его может владелец или администратор компании в административном разделе «Пользователи». Подробнее в статье «Управление пользователями и их правами доступа».

  1. Откройте портал разработчиков Kaiten и перейдите в раздел My Addons.

  2. Создайте новое или откройте дополнение со статусом Draft или Rejected.

    О том, как создать свое дополнение, читайте в статье «Как разработать и добавить свое дополнение для облачной версии».

  3. Заполните блок Vendor & legal info:

    • Vendor name (legal entity) — название юридического лица;

    • Vendor contact phone — контактный телефон;

    • Privacy policy URL — ссылка на политику конфиденциальности;

    • Terms of use URL — ссылка на условия использования;

    • Repository URL — ссылка на репозиторий с исходным кодом (не обязательна).

  1. При создании дополнения вы выбираете, что оно добавит в Kaiten: настройки, блок внутри карточки, кнопки или значки на карточках. Для каждой выбранной возможности в блоке Capability justifications появится отдельное текстовое поле. Например, для кнопок — поле card_buttons — justification. Опишите в нем, зачем дополнению нужны эти кнопки и что они делают.

    Эти пояснения нужны команде Kaiten для проверки дополнения.

Контактный телефон и пояснения из блока Capability justifications видит только команда Kaiten. Эта информация не попадет в общий каталог.

Блок Vendor & legal info в форме дополнения и поля для пояснения выбранных возможностей
  1. Сохраните изменения. Затем откройте меню дополнения и выберите Send for review.

Команда Send for review в меню дополнения
  1. Проверьте информацию в окне подтверждения и снова нажмите Send for review.

Подтверждение отправки дополнения на проверку

Если все обязательные поля и ссылки заполнены, дополнение получит статус Pending review. Если форма заполнена неверно, вы увидите ошибку при отправке. Исправьте ее и повторно отправьте форму.

Как следить за проверкой

Текущий этап отображается в колонке Status:

  • Draft — дополнение доступно внутри вашей компании. Его можно редактировать и тестировать;

  • Pending review — дополнение ждет проверки. Его нельзя удалить, но заявку можно отменить;

  • In review — команда Kaiten проверяет дополнение. Редактирование и удаление недоступны;

  • Published — дополнение прошло проверку и появилось в общем каталоге. Его нельзя редактировать или удалить;

  • Rejected — команда Kaiten отклонила публикацию. После исправлений дополнение можно отправить повторно.

Как отозвать дополнение с проверки

Пока дополнение имеет статус Pending review, откройте его меню и выберите Cancel review.

Команда Cancel review в меню дополнения

Подтвердите отмену. Дополнение вернется в статус Draft, после чего его снова можно редактировать.

Когда статус изменится на In review, отменить проверку уже не получится.

Что делать после отклонения

Если команда Kaiten отклонит публикацию, дополнение получит статус Rejected. Рядом со статусом появится значок: наведите на него, чтобы увидеть причину отказа.

Подсказка с причиной отказа у статуса Rejected

Исправьте замечания, сохраните изменения и снова отправьте аддон на проверку.

Что увидят пользователи в каталоге

В каталоге у дополнения видно название и текст из поля Overview. По ссылке «Подробнее» открывается Description.

Эти два поля читают перед тем, как включить дополнение, поэтому заполните их подробно. В Overview хватит одного предложения о том, что дополнение делает. В Description опишите сценарии, ограничения и свою команду: отдельной строки с названием компании-автора в каталоге нет.

Карточка дополнения в каталоге на пространстве с открытым описанием в «Подробнее»

Полезные ссылки


Didn't find the answer to your question?

Create a request — we'll help you out

Submit a request