Sharing a Module

Last edit: 

Contributors: 

This guide will help you share a module in the Module Marketplace using the Partner Portal.

Requirements

This is an advanced tutorial. To follow it, you should be familiar with basic platformOS concepts, the topics in the Get Started section, and modules. You also need a module to share.

Steps

Sharing a module is a three-step process:

  1. Create zip file
  2. Upload module to the Partner Portal
  3. Add version
  4. Publish module to Module Marketplace

Step 1: Create zip file

Zip the files in modules/MODULE_NAME directory (including that folder).

Step 2: Upload module to the Module Marketplace

Log in to the Partner Portal, and in the menu on the left, click on Create, then select Module.

Fill in the form:

  • Browse image: Select the cover image for your module that will be displayed next to its name in the Module Marketplace. The Cover URL filed is automatically filled out after the image has been uploaded.
  • Name: Enter a name for your module.
  • Description: Enter a short description for your module.
  • Partner: (displayed only for administrator users) Select the Partner that will be the owner of the module.

Click on Create. A "Module successfully created" message appears, and the page of your newly created module is displayed.

Step 3: Add version

On the page of your module, click on Create New Version.

Fill in the form:

  • Browse module: Upload the zip file you created in Step 1.
  • Name: Enter a name for this version of your module.

Click on Create. A "ModuleVersion successfully created" message appears, and the URL is added to your module page.

Step 4: Publish module to Module Marketplace

On the page of your module, click on Publish.

A "This module is published and can be seen in Modules Marketplace" message appears, and the module is listed when you click Modules and then Marketplace.

Next steps

Congratulations! You have shared a module. Now it's ready to be installed.

Questions?

We are always happy to help with any questions you may have. Check out our Help page, or contact us.