Design Automation tutorial review #98
Conversation
- Make use of AppBundle term as it is in the documentation. - Change section title 'Prepare an AppBundle (plugin)', only plugin can mislead.
- Make clear the intention: Use of DA API and development of a sample. - Make clear what is the sample about and what it does. - Provide workflow overview (link to API doc). - Provide link to API documentation for DA terms. - Provide Postman collection doc link for even faster tests.
In order to make it easier to understand, the storyline order changes: creating the AppBundle structure first, and then the logic the activity executes. - Command.cs section move down - new section "Testing locally" created at the botton. Changes inside the sections will be commited next.
- around the AppBundle creation
- around the Activity creation - around the Workitem
- earning readability and visualization
| @@ -17,7 +17,7 @@ | |||
| - [Modify your models](tutorials/modifymodels.md) | |||
| - [Create a server](environment/setup/2legged_da.md) | |||
| - [Basic app UI](designautomation/html/) | |||
| - [Prepare a plugin](designautomation/appbundle/) | |||
| - [Prepare an AppBundle (plugin)](designautomation/appbundle/) | |||
There was a problem hiding this comment.
good point, maybe we should keep it consistent, upper case (AppBundle, Activity, Workitem)
|
|
||
| In this tutorial sample, the activity has 2 inputs (file & JSON data) and 1 output (file). | ||
|
|
||
| > It's worth mentioning again the Design Automation documentation for [entities](https://forge.autodesk.com/en/docs/design-automation/v3/developers_guide/field-guide/), where you can see the relation between them in [Entity Relationships](https://forge.autodesk.com/en/docs/design-automation/v3/developers_guide/field-guide/#entity-relationships) |
There was a problem hiding this comment.
thinking if this image help or not... my perception is that is too complicated, considering this is a basic tutorial, but open to suggestions.
There was a problem hiding this comment.
I agree it can be confusing to show this at the beginning of the tutorial, but this comment is done in purpose in an advanced moment of the tutorial, when creating the Activity, to clarify possible doubts with the API entities (Activity vs Engine vs Workitem vs AppBundle) and the relation between them. At this point, introducing the concept of activity, the rest of the items have to be clear, because in terms of logic-relation is the one which unites them :-)
There was a problem hiding this comment.
maybe move that as a "learn more" in the first paragraph? so we keep the 1st paragraph as general info, the 2nd as the call to action.
| @@ -12,10 +12,30 @@ To define the activity we'll need the executable and the default file extension. | |||
| /// </summary> | |||
| private dynamic EngineAttributes(string engine) | |||
| { | |||
| if (engine.Contains("3dsMax")) return new { commandLine = "$(engine.path)\\3dsmaxbatch.exe -sceneFile \"$(args[inputFile].path)\" $(settings[script].path)", extension = "max", script = "da = dotNetClass(\"Autodesk.Forge.Sample.DesignAutomation.Max.RuntimeExecute\")\nda.ModifyWindowWidthHeight()\n" }; | |||
There was a problem hiding this comment.
this was intentionally left in a single line, to keep it short, and considering this piece won't change much
| @@ -1,4 +1,4 @@ | |||
| # Code for creating App Bundle (Node Js) | |||
| # Create and upload AppBundle (Node Js) | |||
There was a problem hiding this comment.
reminds me to fix Node Js to Node.js
Changes to improve readability:
For review on the pull-request, it is easier to follow the changes in the git commit (from older to newest).
CC: @kevinvandecar @petrbroz @apprentice3d