Appext/template generator docs #10000
Conversation
|
Petar Vukmirovic seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
|
@MarkvanMents Requested a review from you to review/verify changes to the code examples. |
...idocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/command-api.md
Outdated
Show resolved
Hide resolved
|
@MarcellvanRooyen Because users can't access the StudioPro object anymore, can we make it more explicit in one of the docs that they need to create it using the getStudioProApi function? I know there are examples in each How-to, but it would be easiest for users if they could find this information in one doc, rather than needing to search for examples in the How-tos. Maybe we could add an info box in the Getting Started with the Web Extensibility API doc? |
|
Yes that is a good Idea I have updated the getting started guide and added as the first feature we explore. |
There was a problem hiding this comment.
Partially reviewed - @quinntracy , can you see if my suggestions look OK? If they are, can you see whether there are other places where similar changes can be made?
content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/extensibility-api/web/_index.md
Outdated
Show resolved
Hide resolved
|
|
||
| ### Prerequisites | ||
|
|
||
| You will need the following prerequisites: | ||
|
|
||
| * Mendix Studio Pro version 10.21.0 or higher [Mendix Studio Pro](https://marketplace.mendix.com/link/studiopro). | ||
| * [Mendix Studio Pro](https://marketplace.mendix.com/link/studiopro) version 11.2.0 or higher. |
There was a problem hiding this comment.
Does this really not work in previous Mx11 versions?
content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/get-started.md
Outdated
Show resolved
Hide resolved
content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/get-started.md
Outdated
Show resolved
Hide resolved
|
|
||
| To accelerate your extension development, we provide an extension generator that creates a customizable sample extension. | ||
|
|
||
| To use the generator, navigate to your desired source code directory and run the command `npm create @mendix/extension`. You may be prompted by `npm` to grant permission to install the generator. After installation, you will be guided through a series of questions to help configure your extension. |
There was a problem hiding this comment.
What is "your desired source code directory"? Does it mean the application directory containing the .mpr file? Or is it anywhere you want to work on the code and doesn't need to be related to the mpr at all?
...idocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/command-api.md
Outdated
Show resolved
Hide resolved
...idocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/command-api.md
Outdated
Show resolved
Hide resolved
| ``` | ||
|
|
||
| As mentioned, it is also possible to create a context menu that belongs to a document in the app explorer or a document editor, and that menu can have a registered command attached to it. To do so, we can use the `appExplorer` api, or the `documents` api. Please see their respective tutorials, [App Explorer API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/app-explorer-api/) and [Documents API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/documents-api/). | ||
| The command registration for commands that interact with documents are slightly different. They require a payload of type `{ documentId: string }`, which the backend will return the menu gets clicked. The `documentId` is the id of the **exact** document that was interacted with by the menu. |
There was a problem hiding this comment.
Do we need to embolden "exact" - it might make it non-translateable in future?
...idocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/command-api.md
Outdated
Show resolved
Hide resolved
...pidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/dialog-api.md
Outdated
Show resolved
Hide resolved
…ity-api/web/_index.md Co-authored-by: Mark van Ments <[email protected]>
…ity-api/web/get-started.md Co-authored-by: Mark van Ments <[email protected]>
…ity-api/web/get-started.md Co-authored-by: Mark van Ments <[email protected]>
…ity-api/web/get-started.md Co-authored-by: Mark van Ments <[email protected]>
…ity-api/web/web-extensions-howtos/dialog-api.md Co-authored-by: Mark van Ments <[email protected]>
…ity-api/web/web-extensions-howtos/app-explorer-api.md Co-authored-by: Mark van Ments <[email protected]>
…ity-api/web/get-started.md Co-authored-by: Mark van Ments <[email protected]>
…ity-api/web/get-started.md Co-authored-by: Mark van Ments <[email protected]>
…ity-api/web/web-extensions-howtos/app-explorer-api.md Co-authored-by: Mark van Ments <[email protected]>
…ity-api/web/web-extensions-howtos/app-explorer-api.md Co-authored-by: Mark van Ments <[email protected]>
…ity-api/web/web-extensions-howtos/command-api.md Co-authored-by: Mark van Ments <[email protected]>
| * Specify the extension name | ||
| * Choose if you will use React for the extension’s UI | ||
|
|
||
| The next two questions, while optional, are highly recommended, as they enable direct debugging and deployment from Visual Studio Code. These questions request the path to the Studio Pro executable and the application `.mpr` package. The final question allows you to select the Studio Pro version; be sure to choose version 11. |
There was a problem hiding this comment.
What are the two optional questions? I'd like to add them (as well as the final question about selecting the SP version) to the list above so all the setup questions are listed together.
|
@MarcellvanRooyen Can you review/respond to the remaining comments? |
Update documentation to make use of new template generator. This should make a significant improvement to the extension developer experience.