diff --git a/content/en/docs/appstore/create-content/upload-content/_index.md b/content/en/docs/appstore/create-content/upload-content/_index.md index 3b5eaea0e76..6b0fca1149d 100644 --- a/content/en/docs/appstore/create-content/upload-content/_index.md +++ b/content/en/docs/appstore/create-content/upload-content/_index.md @@ -14,7 +14,7 @@ aliases: ## Introduction -The Mendix Marketplace is driven by contributions from members of the community who share the connectors, modules, and apps they have built with the Mendix Platform. This how-to shows how to add and update Marketplace content. +The Mendix Marketplace is driven by contributions from community members who share the connectors, modules, and apps they have built with the Mendix Platform. This how-to teaches you how to do the following: @@ -23,46 +23,45 @@ This how-to teaches you how to do the following: ## Prerequisites -Before starting this how-to, make sure you have completed the following prerequisites: - -* Familiarize yourself with the [Marketplace Overview](/appstore/overview/) and [How to Use Marketplace Content](/appstore/use-content/) +Before starting this how-to, make sure you have reviewed the [Marketplace Overview](/appstore/overview/) and [How to Use Marketplace Content](/appstore/use-content/). ## Adding New Marketplace Content {#adding} -To get started, click **Add Content** in the top bar of the Marketplace home screen. Follow the steps in the sections below to add and submit the content. +To get started, click **Add Content** in the Marketplace home screen. Follow the steps in the sections below to add and submit the content. {{% alert color="info" %}} On each page of the upload flow, click one of the following buttons: -* **Save Draft** to save the details you have entered so far to the draft (which you can access via the [My Drafts](/appstore/home-page/#my-drafts) link in the top bar) -* **Save & Continue** to go to the next page of the upload flow +* **Save Draft & Exit** to store the details you have entered so far as a draft (accessible via [My Drafts](/appstore/home-page/#my-drafts)) and exit the upload flow +* **Next** to continue to the next page in the upload flow {{% /alert %}} ### General {#general} -On the **General** page, you need to provide some details about your component. +Provide key details about your component on the **General** page. #### Describing Your Content Follow these steps to describe your content: -1. Select a **Content type** for your component. +1. Select a **Content Type** for your component. - {{% alert color="warning" %}}You can only set the content type in the initial version of your content. You cannot change this setting after the initial version is published.{{% /alert %}} + {{% alert color="warning" %}}You can only set the content type when creating the initial version of your content. You cannot change this setting after it is published.{{% /alert %}} 2. Select the location **Visibility** where you want to publish your component: * **Public Marketplace (all Mendix users)** – your component will be available to the Mendix community - * This content will have to be reviewed and approved by Mendix before it is available) + * This content will have to be reviewed and approved by Mendix before it is available * **Private Marketplace (your company only)** – your content will receive the **Private** label and be available only via your [Company Content](/appstore/home-page/#company-content) page * Selected private content of a content group can also be made available to [content group guests](/appstore/home-page/#guests) for download * This content will not be reviewed by Mendix {{% alert color="warning" %}}You can only set the location in the initial version of your content. You cannot change this setting by updating the Marketplace component later.{{% /alert %}} -3. You can add one **Category** (up to three total) for your component. A category groups similar components or services together that share common characteristics, functions, or purposes. Categories make it easier for Marketplace users to find what they are looking for. -4. Enter a **Name** for your component. -5. Enter a **Description** of your component. +3. You can add one **Category** (up to three total) for your component. A category groups similar components or services that share characteristics, functions, or purposes. Categories make it easier for Marketplace users to find what they are looking for. +4. Select a maximum of three tags for the **Industry** to indicate the sectors the component will operate. +5. Enter a **Name** for your component. +6. Enter a **Description** of your component. {{% alert color="warning" %}}You can use rich text in the editor. However, using rich text at the beginning of the description is not recommended, as it will not get rendered properly. You should add a few lines of regular text before using rich text.{{% /alert %}} @@ -83,14 +82,14 @@ These are the open-source software license options available and their requireme | **Creative Commons CC0 1.0 Universal (CC-0)** (Public Domain) | | {{< icon name="checkmark-circle-filled" color="green" >}} | {{< icon name="remove-circle-filled" color="red" >}} | {{< icon name="remove-circle-filled" color="red" >}} | {{< icon name="checkmark-circle-filled" color="green" >}} | {{< icon name="checkmark-circle-filled" color="green" >}} | {{< icon name="remove-circle-filled" color="red" >}} | {{< icon name="remove-circle-filled" color="red" >}} | {{< icon name="checkmark-circle-filled" color="green" >}} | {{% alert color="info" %}} -The [GNU General Public License (GPL), version 3](https://www.gnu.org/licenses/gpl-3.0.en.html) is not available to use, as everything licensed under GNU GPL is public; GNU GPL has a strong copyleft effect; modification has a strong copyleft effect; and all consuming apps should make their code public. +The [GNU General Public License (GPL), version 3](https://www.gnu.org/licenses/gpl-3.0.en.html) is not available to use, as everything licensed under GNU GPL is public. Its strong copyleft effect mandates that any modifications and derivative works, including consuming apps, must have their source code public. {{% /alert %}} ##### Proprietary Licenses {#proprietary-license} -You can configure your own proprietary license for your company’s content. The license can be used for multiple components, and it can be used by everyone within your organization. +You can configure a proprietary license for your company’s content, which can be applied to multiple components and used by everyone within your organization. -This license can be created for a new **Public Marketplace (all Mendix users)** component by requesting a new license and submitting it alongside the component. The license needs to be approved by Mendix after you have created and submitted it the first time. Once it has been submitted for approval, you and the people within your organization can also use it it for other components. +This license can be created for a new **Public Marketplace (all Mendix users)** component by requesting a new license and submitting it alongside the component. The license needs to be approved by Mendix after you have created and submitted it the first time. Once approved, you and the people within your organization can use it it for other components. Follow these steps to configure a proprietary license for a new public component: @@ -105,7 +104,6 @@ A lead is a potential sales contact that expresses interest in your product or s * Solutions * Industry templates -* Services When prospective customers are interested in your product, they can leave their contact information using the Marketplace product listing. This is done by clicking a call-to-action button and filling in a form. @@ -121,9 +119,9 @@ In the **How would you like to receive information on new leads?** field, you mu #### Finishing Up -To finish up configuring this page, click **Upload** to upload an icon for your component. +To finish up configuring the **General** page, click **Upload Image** to upload a cover image for your component. -{{< figure src="/attachments/appstore/submit-content/general.png" class="no-border" >}} +{{< figure src="/attachments/appstore/submit-content/general.png" >}} ### Package {#package} @@ -135,9 +133,11 @@ On the **Package** page, you can **Upload Source File**: * If you select **Manual upload**, follow the steps in the dialog box for uploading the package source file * When you are finished, click **Save** -* If you select **GitHub URL**, follow the steps in the dialog box for copying the link of the release you want to import (for details, see the [Using a GitHub Repo](/appstore/guidelines-content-creators/#github) section in *Guidelines for Content Creators*. - * To include the repo's *README.md* file on the component's [Documentation](#doc) tab, make sure you have checked the **Import Documentation** box - * When you are finished, click **OK** +* If you select **GitHub URL**, follow the steps in the dialog box for copying the link of the release you want to import (for details, see the [Using a GitHub Repo](/appstore/guidelines-content-creators/#github) section in *Guidelines for Content Creators*). + * To include the repo's *README.md* file on the component's [Documentation](#doc) tab, make sure you check the **Import Documentation** box + * Click **OK** to finish + +Optionally select **Compatibility** to test whether your component works with the React Client in Mendix Studio Pro 10.7 or higher. For details, see the [Widgets](/appstore/guidelines-content-creators/#github) section in *Mendix React Client*. Note that this option is only available if you selected **Widget** as the **Content Type** on the **General** page. Select the **Studio Pro Version** on which you built the content. @@ -147,7 +147,7 @@ Enter **Release Notes** for the component in the box provided describing what is ### Enable {#doc} -On the **Enable** page, you can enter details on requirements and configuration for your component in the **Documentation**. Note that the documentation option is only available when the **Import Documentation** box has not been selected on the **Package** page above. +On the **Enable** page, you can enter details on requirements and configuration for your component in the **Documentation**. Note that the documentation option is only available when the **Import Documentation** box has not been selected on the **Package** page. Follow the template for the recommended content: @@ -160,33 +160,21 @@ Follow the template for the recommended content: * The **Installation** steps and details * The **Configuration** steps and details * Any **Known bugs** - * Any **Frequently asked questions** + * Any **Frequently Asked Questions** The editor comes with a set of basic formatting tools, such as bold, bullet lists, and URL links. Click **Upload Screenshot** to select images of the component (especially for configuration) from your computer and upload them (this is required for submitting a new component): -{{< figure src="/attachments/appstore/submit-content/enable.png" class="no-border" >}} +{{< figure src="/attachments/appstore/submit-content/enable.png" >}} You can optionally add a **YouTube URL** and a **Demo URL**. -### Capabilities {#capabilities} - -On the **Capabilities** page, you can provide the following details about an industry template: - -* A category recommendation in the **Industry Cloud** section -* A **Banner** that will be displayed on your content page -* One or more key features to leverage in the **Solution Capabilities** section (for each capability, enter a **Name** and **Description**) -* A **Use Case** relevant to the content (enter a **Header** and **CTA URL**) -* **External Links** relevant to the content - -{{< figure src="/attachments/appstore/submit-content/capabilities.png" class="no-border" >}} - ### Publish {#publish} Finally, on the **Publish** page, you can review all the details of your component you entered so far and edit as necessary (via the **Edit** button per section) before publishing. -{{< figure src="/attachments/appstore/submit-content/publish.png" width="600" class="no-border" >}} +{{< figure src="/attachments/appstore/submit-content/publish.png" width="600" >}} After you click **Publish Content**, your draft will be reviewed by Mendix before it is visible in the Marketplace. @@ -194,7 +182,9 @@ For details on the approval process, see [Governance Process](/appstore/submit-c ## Updating Existing Marketplace Content {#updating} -After you publish a component in the Mendix Marketplace, it is your responsibility to make sure that components are updated on a regular cadence. This is important so that components work with the latest versions of dependencies (especially Mendix Studio Pro), and it is required so Mendix can ensure the quality of components in the Marketplace. This means you need to monitor, maintain, and evolve the component so that the Marketplace listing is more noticeable, you can build user loyalty, and you can maintain the good reputation of your company. If the component is not updated regularly, the Marketplace listing will be analyzed for removal from public visibility. +After you publish a component in the Mendix Marketplace, your are responsible for keeping it updated on a regular cadence. These regular updates are important to maintain compatibility with the latest dependencies (especially Mendix Studio Pro), and are required for Mendix to ensure the quality of components in the Marketplace. + +To meet these expectations, you must monitor, maintain, and evolve the component to improve its visibility on the Marketplace, build user loyalty, and maintain your company's reputation. If the component is not updated regularly, the listing will be reviewed for removal from public visibility. Mendix expects the following updates for components in the Platform, Community, and Premium [support categories](/appstore/marketplace-content-support/#category): @@ -205,14 +195,14 @@ Mendix expects the following updates for components in the Platform, Community, To update content that has already been published, follow these steps: -1. Find the component by clicking **My Marketplace** and selecting one of the following: +1. Find the component by clicking one of the following: * **My Content** * **Company Content** - * **Content Groups** (note that if an existing Marketplace component is assigned to a [content group](/appstore/home-page/#content-groups) as specific content group [content](/appstore/home-page/#group-content), you can only update the component if you are a member of that group) + * **Content Group** (note that if an existing Marketplace component is assigned to a [content group](/appstore/home-page/#content-groups) as specific content group [content](/appstore/home-page/#group-content), you can only update the component if you are a member of that group) 2. Click the menu item next to the component you want to update and select **Manage Draft**. - {{% alert color="info" %}}Only one draft version of a component can exist at a time, so when one draft version is in progress, another draft cannot be started. If there is a draft version in progress, click **View draft** on the page where you manage the component in order to see the draft.{{% /alert %}} + {{% alert color="info" %}}Only one draft version of a component can exist at a time, so when one draft version is in progress, another draft cannot be started. If there is a draft version in progress, click **Edit Draft** on the page where you manage the component in order to see the draft.{{% /alert %}} 3. You can edit all component details, as described in the [Adding New Marketplace Content](#adding) section above. 4. In the **Version** section of the **Package** page, update the **Major**, **Minor**, and **Patch** numbers so that the component is saved as a new version: @@ -221,4 +211,4 @@ To update content that has already been published, follow these steps: * **Minor update** – new features that do not break existing usage. * **Patch** – a small change that fixes bugs or security issues. -5. On the **Publish** page, you can review all the details of your component you entered so far and edit as necessary (via the **Edit Section** button) before clicking **Publish Content**. +5. On the **Publish** page, you can review all the details of your component entered so far and edit as necessary using the **Edit** button in each section before clicking **Publish Content**.