You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/appstore/create-content/upload-content/_index.md
+34-44Lines changed: 34 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ aliases:
14
14
15
15
## Introduction
16
16
17
-
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.
17
+
The Mendix Marketplace is driven by contributions from community members who share the connectors, modules, and apps they have built with the Mendix Platform.
18
18
19
19
This how-to teaches you how to do the following:
20
20
@@ -23,46 +23,45 @@ This how-to teaches you how to do the following:
23
23
24
24
## Prerequisites
25
25
26
-
Before starting this how-to, make sure you have completed the following prerequisites:
27
-
28
-
* Familiarize yourself with the [Marketplace Overview](/appstore/overview/) and [How to Use Marketplace Content](/appstore/use-content/)
26
+
Before starting this how-to, make sure you have reviewed the [Marketplace Overview](/appstore/overview/) and [How to Use Marketplace Content](/appstore/use-content/).
29
27
30
28
## Adding New Marketplace Content {#adding}
31
29
32
-
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.
30
+
To get started, click **Add Content** in the Marketplace home screen. Follow the steps in the sections below to add and submit the content.
33
31
34
32
{{% alert color="info" %}}
35
33
<aid="draft"></a>On each page of the upload flow, click one of the following buttons:
36
34
37
-
***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)
38
-
***Save & Continue** to go to the next page of the upload flow
35
+
***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
36
+
***Next** to continue to the next page in the upload flow
39
37
{{% /alert %}}
40
38
41
39
### General {#general}
42
40
43
-
On the **General** page, you need to provide some details about your component.
41
+
Provide key details about your component on the **General** page.
44
42
45
43
#### Describing Your Content
46
44
47
45
Follow these steps to describe your content:
48
46
49
-
1. Select a **Content type** for your component.
47
+
1. Select a **Content Type** for your component.
50
48
51
-
{{% 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 %}}
49
+
{{% 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 %}}
52
50
53
51
2. Select the location **Visibility** where you want to publish your component:
54
52
55
53
* <aid="public"></a>**Public Marketplace (all Mendix users)** – your component will be available to the Mendix community
56
-
* This content will have to be reviewed and approved by Mendix before it is available)
54
+
* This content will have to be reviewed and approved by Mendix before it is available
57
55
* <aid="private"></a>**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
58
56
* Selected private content of a content group can also be made available to [content group guests](/appstore/home-page/#guests) for download
59
57
* This content will not be reviewed by Mendix
60
58
61
59
{{% 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 %}}
62
60
63
-
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.
64
-
4. Enter a **Name** for your component.
65
-
5. Enter a **Description** of your component.
61
+
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.
62
+
4. Select a maximum of three tags for the **Industry** to indicate the sectors the component will operate.
63
+
5. Enter a **Name** for your component.
64
+
6. Enter a **Description** of your component.
66
65
67
66
{{% 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 %}}
68
67
@@ -83,14 +82,14 @@ These are the open-source software license options available and their requireme
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.
85
+
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.
87
86
{{% /alert %}}
88
87
89
88
##### Proprietary Licenses {#proprietary-license}
90
89
91
-
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.
90
+
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.
92
91
93
-
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.
92
+
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.
94
93
95
94
Follow these steps to configure a proprietary license for a new public component:
96
95
@@ -105,7 +104,6 @@ A lead is a potential sales contact that expresses interest in your product or s
105
104
106
105
* Solutions
107
106
* Industry templates
108
-
* Services
109
107
110
108
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.
111
109
@@ -121,9 +119,9 @@ In the **How would you like to receive information on new leads?** field, you mu
121
119
122
120
#### Finishing Up
123
121
124
-
To finish up configuring this page, click **Upload** to upload an icon for your component.
122
+
To finish up configuring the **General**page, click **Upload Image** to upload a cover image for your component.
@@ -135,9 +133,11 @@ On the **Package** page, you can **Upload Source File**:
135
133
136
134
* If you select **Manual upload**, follow the steps in the dialog box for uploading the package source file
137
135
* When you are finished, click **Save**
138
-
* 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*.
139
-
* To include the repo's *README.md* file on the component's [Documentation](#doc) tab, make sure you have checked the **Import Documentation** box
140
-
* When you are finished, click **OK**
136
+
* 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*).
137
+
* To include the repo's *README.md* file on the component's [Documentation](#doc) tab, make sure you check the **Import Documentation** box
138
+
* Click **OK** to finish
139
+
140
+
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.
141
141
142
142
Select the **Studio Pro Version** on which you built the content.
143
143
@@ -147,7 +147,7 @@ Enter **Release Notes** for the component in the box provided describing what is
147
147
148
148
### Enable {#doc}
149
149
150
-
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.
150
+
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.
151
151
152
152
Follow the template for the recommended content:
153
153
@@ -160,41 +160,31 @@ Follow the template for the recommended content:
160
160
* The **Installation** steps and details
161
161
* The **Configuration** steps and details
162
162
* Any **Known bugs**
163
-
* Any **Frequently asked questions**
163
+
* Any **Frequently Asked Questions**
164
164
165
165
The editor comes with a set of basic formatting tools, such as bold, bullet lists, and URL links.
166
166
167
167
<aid="screenshot"></a>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):
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.
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.
185
+
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.
186
+
187
+
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.
198
188
199
189
Mendix expects the following updates for components in the Platform, Community, and Premium [support categories](/appstore/marketplace-content-support/#category):
200
190
@@ -205,14 +195,14 @@ Mendix expects the following updates for components in the Platform, Community,
205
195
206
196
To update content that has already been published, follow these steps:
207
197
208
-
1. Find the component by clicking **My Marketplace** and selecting one of the following:
198
+
1. Find the component by clicking one of the following:
209
199
***My Content**
210
200
***Company Content**
211
-
***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)
201
+
***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)
212
202
213
203
2. Click the menu item next to the component you want to update and select **Manage Draft**.
214
204
215
-
{{% 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 %}}
205
+
{{% 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 %}}
216
206
217
207
3. You can edit all component details, as described in the [Adding New Marketplace Content](#adding) section above.
218
208
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:
221
211
***Minor update** – new features that do not break existing usage.
222
212
***Patch** – a small change that fixes bugs or security issues.
223
213
224
-
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**.
214
+
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**.
0 commit comments