added basic documentation for using extensions #7395

mauritselzinga-mx · 2024-03-06T08:49:31Z

Added documentation for how to use extensions in Studio Pro, and how to install an extension.

Creating initial extension documentation so that we can clairfy what it is and how to install extensions in the documentation.

Added images and information

created folder

Removed dummy file that was created when creating extensions folder through github

added info for version

MariaShaposhnikova · 2024-03-11T15:23:45Z

Hi @mauritselzinga-mx , thanks for submitting the PR! A few questions about extensions:

We currently have documentation on add-on modules and solutions for SP, how is extension different from them? In the Marketplace guide, we have categories for Modules, Services, Widgets, Partner Solutions, are extensions part of any of those?
Does the term "extension" appear anywhere in the UI in SP?
Are extensions marked as Platform-Supported in the Marketplace?

mauritselzinga-mx · 2024-03-11T16:58:19Z

Hi Maria, Extensions can be packaged in Add-on modules, but contain functionality that extend studio pro, much like a plugin. We also have a dedicated extensions category in the marketplace. Since this adds functionality to SP, it’s diferent than most other modules, which extend the model or modelling language with widgets or java actions. The term extension does currently not occur yet in Studio Pro, but soon it will in an extensions overview. Extensions that are provided by mendix will be marked as platform-supported. Currently though, we only have the industrial edge plugin which is made by Siemens. Maurits Elzinga Sr. Product Manager | Mendix | Studio Pro From: Maria Shaposhnikova ***@***.***> Date: Monday, 11 March 2024 at 16:24 To: mendix/docs ***@***.***> Cc: Maurits Elzinga ***@***.***>, Mention ***@***.***> Subject: Re: [mendix/docs] added basic documentation for using extensions (PR #7395) You don't often get email from ***@***.*** Learn why this is important<https://aka.ms/LearnAboutSenderIdentification> Hi @mauritselzinga-mx<https://github.com/mauritselzinga-mx> , thanks for submitting the PR! A few questions about extensions: 1. We currently have documentation on add-on modules and solutions for SP, how is extension different from them? In the Marketplace guide, we have categories for Modules, Services, Widgets, Partner Solutions, are extensions part of any of those? 2. Does the term "extension" appear anywhere in the UI in SP? 3. Are extensions marked as Platform-Supported in the Marketplace? — Reply to this email directly, view it on GitHub<#7395 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A5C5FCBQRCON75I4IIIQGQTYXXEBPAVCNFSM6AAAAABEITXUP2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOBYG4YDINRYGY>. You are receiving this because you were mentioned.Message ID: ***@***.***>

MariaShaposhnikova · 2024-03-15T10:31:35Z

Hi @mauritselzinga-mx , I've reviewed the PR. Based on your answers on extensions and after a discussion with other tech writers, I suggest the following:

I've moved all info the Marketplace guide > Using Marketplace Content. It feels a better place for this type of information and we will keep all Marketplace-related info for SP in one place.
I got rid of some images and left the one I felt was most important and relevant.

MariaShaposhnikova · 2024-03-15T10:32:01Z

content/en/docs/appstore/overview/use-content.md

+
+#### 3.3.1 Studio Pro Extensions API
+
+The Studio Pro Extensions API allows you to customize different parts of Mendix Studio Pro by adding a new functionality to them, as well as interact with the open app model. 


@mauritselzinga-mx , can we add a link to this API here?

The API is currently not yet public and only available to partners and ISVs. Once this becomes public we can definitely add the link here

@MarkvanMents @MariaShaposhnikova As Maurits said, the API is not public yet. Then should we offer this information about the API in our public facing documentation at this point?

Note that the API isn't public, but extension usage by all users is. So might be relevant for users to know what they are actually retrieving

I think that we should say somewhere that when you download an extension it is adding functionality to Studio Pro and it isn't just a module in your app.
I think we should also say that all these are platform supported, otherwise customers will be uncomfortable that they are running additional code which can affect the functioning of Studio Pro.
However, I don't think we should technically say that this is done via an API as the mechanism is irrelevant to the user.

MariaShaposhnikova · 2024-03-15T10:33:08Z

@Luyao-Zhang-1 , as agreed before, I've moved extention info to the Marketplace guide, could you take a look at the changes when you have time?

Luyao-Zhang-1 · 2024-03-15T13:21:54Z

content/en/docs/appstore/overview/use-content.md

+
+It is possible to add new functionality to these elements and add custom interfaces that interact with the current open app model.
+
+#### 3.3.2 Installing Extensions


Would it be better to put this section under 3.2 Importing Content from Studio Pro's App Explorer instead, as this section seems to be about installing Marketplace content?

@Luyao-Zhang-1, I think extensions appear as modules in the end, that is why I've put it after modules (Using a Module). I agree that the instructions seem to focus mainly on installion, but also mention Extension API, for example,

they indeed appear as modules, however you do get some different behavior when importing an extension rather than a regular module.

Luyao-Zhang-1 · 2024-03-15T16:28:46Z

Hi Maria, Extensions can be packaged in Add-on modules, but contain functionality that extend studio pro, much like a plugin. We also have a dedicated extensions category in the marketplace. Since this adds functionality to SP, it’s diferent than most other modules, which extend the model or modelling language with widgets or java actions. The term extension does currently not occur yet in Studio Pro, but soon it will in an extensions overview. Extensions that are provided by mendix will be marked as platform-supported. Currently though, we only have the industrial edge plugin which is made by Siemens. Maurits Elzinga Sr. Product Manager | Mendix | Studio Pro From: Maria Shaposhnikova @.> Date: Monday, 11 March 2024 at 16:24 To: mendix/docs @.> Cc: Maurits Elzinga @.>, Mention @.> Subject: Re: [mendix/docs] added basic documentation for using extensions (PR #7395) You don't often get email from @.*** Learn why this is importanthttps://aka.ms/LearnAboutSenderIdentification Hi @mauritselzinga-mx https://github.com/mauritselzinga-mx , thanks for submitting the PR! A few questions about extensions: 1. We currently have documentation on add-on modules and solutions for SP, how is extension different from them? In the Marketplace guide, we have categories for Modules, Services, Widgets, Partner Solutions, are extensions part of any of those? 2. Does the term "extension" appear anywhere in the UI in SP? 3. Are extensions marked as Platform-Supported in the Marketplace? — Reply to this email directly, view it on GitHub<#7395 (comment)>, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A5C5FCBQRCON75I4IIIQGQTYXXEBPAVCNFSM6AAAAABEITXUP2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOBYG4YDINRYGY. You are receiving this because you were mentioned.Message ID: @.***>

@mauritselzinga-mx Currently in the Marketplace, if I select Extensions as the category, confusingly, I get Advanced Audit Trail and Windows Service Console (please see the screenshot below). Do these two modules fit the definition of an extension as described here?

MarkvanMents · 2024-04-12T14:15:10Z

content/en/docs/appstore/modules/_index.md

-* [Database Connector](/appstore/modules/database-connector/)
-* [Mendix Feedback](/appstore/modules/mendix-feedback/)
-* [Mendix Mini Surveys](/appstore/modules/mendix-mini-surveys/)
+<a id="extensions"></a>{{% alert color="info" %}}Extensions are a special type of modules that allows you to add new functionality to your development environment in Studio Pro. Extensions are part of your application, and therefore will become available to all members of your app who are developing it. Extensions come as part of [add-on modules](/refguide/consume-add-on-modules-and-solutions/). This means you can download them directly from the Marketplace.</br>Currently, extensions can only be created by Mendix Partners and are available from Studio Pro versions [10.6.3](/releasenotes/studio-pro/10.6/#1063) and above.


Do we really need an anchor here. It is only two lines below the Introduction and I don't think we really need to scroll to it.
I would just link the the document or, if necessary, add an anchor for the introduction.

content/en/docs/appstore/modules/_index.md

content/en/docs/appstore/overview/use-content.md

MarkvanMents · 2024-04-12T14:26:00Z

content/en/docs/appstore/overview/use-content.md

+    * [Extensions](#extensions)
+    * [Apps](#apps)
+
+##### 2.1.1.1 Widgets {#widgets}


I wonder if we could get rid of one level of heading by having

2.1 Finding and Download Content in Studio Pro 9.19 and above

2.2 Finding and Downloading Content in Studio Pro 9.18 and below

Not worth doing now, but perhaps we can look at the structure as this seems to be a very long section number for something which is actually quite simple!

Or perhaps we can do something without section numbers?

Not sure exactly - but something to look at later?

Sounds good. We can take a look at this later.

content/en/docs/appstore/overview/use-content.md

Update use-content.md

Co-authored-by: Mark van Ments <35492184+MarkvanMents@users.noreply.github.com>

…into pr/7395

mauritselzinga-mx added 6 commits March 6, 2024 09:32

Create extensions.md

8a5f264

Creating initial extension documentation so that we can clairfy what it is and how to install extensions in the documentation.

Update extensions.md

19f6805

Added images and information

Create extensions folder

3e64c2f

created folder

added images for extensions documentation

e670e6f

Delete static/attachments/refguide/extensions/temp.md

a5f116f

Removed dummy file that was created when creating extensions folder through github

Update extensions.md

67125d3

added info for version

MariaShaposhnikova self-assigned this Mar 6, 2024

MariaShaposhnikova added the Needs language review label Mar 6, 2024

Move to the Marketplace and review

fac3918

MariaShaposhnikova reviewed Mar 15, 2024

View reviewed changes

MariaShaposhnikova requested a review from Luyao-Zhang-1 March 15, 2024 10:32

Luyao-Zhang-1 reviewed Mar 15, 2024

View reviewed changes

Luyao-Zhang-1 added 2 commits March 15, 2024 17:21

add extensions as a category

38894a7

re-numbering

a333a95

remove "connector" as it's not a content type anymore

cf44e3f

Luyao-Zhang-1 self-assigned this Mar 21, 2024

Luyao-Zhang-1 and others added 9 commits April 12, 2024 15:07

add info of extensions to modules index page

131230a

add an anchor to the note

371224a

restructure the section

4ca897e

markdown styling

76a7131

style

e4f8785

Merge branch 'development' into patch-13

1f6aec6

correct numbering

985045d

Uppercase

45d5806

remove the broken link

61ba7f7

MarkvanMents reviewed Apr 12, 2024

View reviewed changes

content/en/docs/appstore/modules/_index.md Outdated Show resolved Hide resolved

MarkvanMents reviewed Apr 12, 2024

View reviewed changes

content/en/docs/appstore/overview/use-content.md Outdated Show resolved Hide resolved

MarkvanMents reviewed Apr 12, 2024

View reviewed changes

content/en/docs/appstore/overview/use-content.md Show resolved Hide resolved

MarkvanMents reviewed Apr 12, 2024

View reviewed changes

content/en/docs/appstore/overview/use-content.md Outdated Show resolved Hide resolved

MarkvanMents reviewed Apr 12, 2024

View reviewed changes

content/en/docs/appstore/overview/use-content.md Outdated Show resolved Hide resolved

Luyao-Zhang-1 added 2 commits April 12, 2024 16:50

move anchor to introduction

eb4aaf3

Update use-content.md

remove extensions from Studio Pro lower versions

d20dd28

Luyao-Zhang-1 force-pushed the patch-13 branch from 9e5b21f to d20dd28 Compare April 12, 2024 14:50

Luyao-Zhang-1 and others added 3 commits April 12, 2024 16:51

Update content/en/docs/appstore/overview/use-content.md

f33de11

Co-authored-by: Mark van Ments <35492184+MarkvanMents@users.noreply.github.com>

Update use-content.md

9585d12

Merge branch 'patch-13' of https://github.com/mauritselzinga-mx/docs …

b23e4f8

…into pr/7395

Luyao-Zhang-1 removed the Needs language review label Apr 12, 2024

Luyao-Zhang-1 merged commit 12d7323 into mendix:development Apr 12, 2024


		#### 3.3.1 Studio Pro Extensions API

		The Studio Pro Extensions API allows you to customize different parts of Mendix Studio Pro by adding a new functionality to them, as well as interact with the open app model.


		It is possible to add new functionality to these elements and add custom interfaces that interact with the current open app model.

		#### 3.3.2 Installing Extensions

added basic documentation for using extensions #7395

added basic documentation for using extensions #7395

Uh oh!

Conversation

mauritselzinga-mx commented Mar 6, 2024

Uh oh!

MariaShaposhnikova commented Mar 11, 2024

Uh oh!

mauritselzinga-mx commented Mar 11, 2024 via email

Uh oh!

MariaShaposhnikova commented Mar 15, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Luyao-Zhang-1 Mar 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MariaShaposhnikova commented Mar 15, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MariaShaposhnikova Mar 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Luyao-Zhang-1 commented Mar 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

2.1 Finding and Download Content in Studio Pro 9.19 and above

2.2 Finding and Downloading Content in Studio Pro 9.18 and below

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Luyao-Zhang-1 Mar 18, 2024 •

edited

Loading

MariaShaposhnikova Mar 15, 2024 •

edited

Loading

Luyao-Zhang-1 commented Mar 15, 2024 •

edited

Loading