Как подготовить плагин к публикации

Пользователи Трекера могут найти и подключить плагины в каталоге: Как подключить и использовать плагины.

Чтобы добавить разработанный вами плагин в каталог:

1. Подготовьте для плагина описание и изображения.

2. Подготовьте справку — документацию для пользователей.

3. Отправьте плагин на публикацию.

4. Дождитесь, пока он пройдет модерацию.

Когда плагин пройдет модерацию, он появится в каталоге вашей организации с запросом на подключение. Как одобрить запрос

Разработанный в организации плагин также можно добавить в публичный каталог, чтобы он стал доступен сотрудникам других организаций. Для этого обратитесь в поддержку Трекера.

Оформление карточки

Перед публикацией добавьте в проект изображения и описание для карточки плагина:

• public/logo.svg — логотип плагина, должен иметь квадратную форму;
• marketplace/header-image.jpg — изображение для карточки плагина, должно иметь пропорции 2,41:1;
• marketplace/index.md — описание для карточки плагина.

Справка плагина

Справка — это документация вашего плагина для пользователей. Она отображается в каталоге плагинов и в точке интеграции в интерфейсе Трекера.

Существует два способа подключить справку: разместить её на внешнем домене или включить прямо в дистрибутив плагина.

Внешняя справка

Если документация уже размещена на вашем домене, укажите ссылку на неё в поле docsUrl файла manifest.json:

{
    "docsUrl": "https://example.com/docs/plugin.html",
    "slots": {
        "tracker": {
            "issue.action": [
                {
                    "entrypoint": "index.html",
                    "contextLevel": "basic",
                    "title": {
                        "ru": "Мой плагин",
                        "en": "My Plugin"
                    }
                }
            ]
        }
    }
}

Трекер отобразит ссылку на справку в каталоге плагинов и в точке интеграции вашего плагина.

Внутренняя справка

Если вы хотите включить документацию прямо в дистрибутив плагина, создайте папку docs/ в корне проекта и разместите в ней файлы index.md и toc.yaml. Файл toc.yaml описывает структуру документа:

title: My Docs
href: index.md
items:
    - name: Introduction
      href: index.md
    - name: Getting Started
      href: getting-started.md
    - name: Reference
      href: reference.md

Структура файлов

Минимальная структура для одностраничной справки:

docs/
├── toc.yaml
└── index.md

Превью

Если вы хотите посмотреть, как документация будет выглядеть — запустите команду build-docs и откройте docs-build/index.html в браузере.

Публикация справки

При публикации плагина справка автоматически собирается с помощью Diplodoc. После успешной проверки в манифест плагина будет проставлена ссылка /docs/index.html.

Справка не встраивается в интерфейс Трекера — пользователь переходит по ссылке, как и в случае с внешней справкой.

Публикация плагина

Чтобы отправить плагин на публикацию:

1. Получите токен для CLI:

   weavix login
   

2. Запустите публикацию:

   weavix submit
   

   Команда сама выполнит регистрацию плагина при необходимости, загрузку дистрибутива и отправку версии на модерацию.

3. После отправки на модерацию проверяйте статус публикации:

   weavix list
   

Добавление в каталог

Каждая новая версия плагина сначала проходит проверку команды Трекера. После того как плагин пройдет модерацию, он появится в каталоге.

Прежде чем пользователи смогут использовать плагин, администратор организации получит запрос на подключение плагина. Подтверждение нужно для каждой новой версии плагина. Как администратору одобрить плагин

После подтверждения администратором плагин станет доступен пользователям организации так же, как плагины из общего каталога. Как подключить плагин

Чтобы плагин, созданный для вашей организации, стал доступен всем пользователям Трекер в общем каталоге, обратитесь в службу поддержки.