Preparing a plugin for publishing

Tracker users can find and enable plugins in the catalog: How to connect and use plugins.

To add your developed plugin to the catalog:

1. Prepare the description and images for the plugin.

2. Prepare the help — documentation for users.

3. Submit the plugin for publishing.

4. Wait for it to pass moderation.

Once the plugin passes moderation, it will appear in the catalog of your organization with a request to enable. How to approve a request

A plugin developed in your organization can also be added to the public catalog so that it becomes available to employees of other organizations. To do this, contact Tracker support.

Designing the card

Before publishing, add images and a description for the plugin card to the project:

• public/logo.svg — plugin logo, must be square.
• marketplace/header-image.jpg — image for the plugin card, must have a 2.41:1 aspect ratio.
• marketplace/index.md — description for the plugin card.

Plugin category

To make plugins easier to find, they're grouped by category in the catalog. When creating or publishing a plugin, you need to specify its categories. Categories are set in the manifest in the categories field.

Full list of available categories:

Plugin help

Help is your plugin's documentation for users. It's displayed in the plugin catalog and at the integration point in the Tracker interface.

There are two ways to provide help: host it on an external domain or include it directly in the plugin distribution package.

External help

If the documentation is already hosted on your domain, specify a link to it in the docsUrl field of manifest.json:

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

Tracker will display a link to the help in the plugin catalog and at your plugin's integration point.

Internal help

If you want to include documentation directly in the plugin distribution package, create a docs/ folder in the project root and place the index.md and toc.yaml files inside. The toc.yaml file describes the document structure:

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

File structure

Minimum structure for a single-page help:

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

Preview

If you want to see what the documentation will look like, run the build-docs command and open docs-build/index.html in your browser.

Publishing help

When publishing the plugin, the help is automatically built with Diplodoc. After successful verification, the /docs/index.html link will be added to the plugin manifest.

The help is not embedded in the Tracker interface — the user follows the link, just like with external help.

Publishing the plugin

To submit a plugin for publishing:

1. Get a token for the CLI:

   weavix login
   

2. Run the publishing:

   weavix submit
   

   This command will automatically register the plugin if needed, upload the distribution package, and submit the version for moderation.

3. After submitting for moderation, check the publishing status:

   weavix list
   

Adding to the catalog

After automatic moderation, the plugin will appear in your organization's catalog with a request to enable. The organization administrator will need to approve it. How to approve a request

Once approved by the administrator, the plugin will become available to the organization's users just like plugins from the general catalog. How to enable a plugin

To make a plugin created for your organization available to all Tracker users in the general catalog, contact the support team.