o3de / sig-content

8 stars 12 forks source link

Added Lua Scripting workflow file #106

Closed LB-ArturZieba closed 1 year ago

LB-ArturZieba commented 1 year ago

Signed-off-by: Artur Zięba 86952082+LB-ArturZieba@users.noreply.github.com

Change summary:

michleza commented 1 year ago

Notes as I went through the LKG:

LB-ArturZieba commented 1 year ago

Notes as I went through the LKG:

  • Let's keep list items as bullet points in the requests column unless they are steps or a number of things the user should be aware of.
  • I think the idea of an LKG workflow is that 'Requests' are suggestions for things to test around as the user navigates that area of the project and not necessarily everything that needs to be completed for the workflow/timebox
  • Add some images for buttons since this editor's UI is pretty dense and it can be difficult to find some of the controls

I have addressed all of the above points:

  1. This was addressed as a part of the changes requested by @FuzzyCarterAWS, inline text was changed to lists where appropriate.
  2. Adjusted two "Requests" in the "Properties usage in Lua scripts" area as per this request.
  3. Added images where the description could be ambiguous.
michleza commented 1 year ago

I like the revisions that have been made. This is criticism of github markdown and not your work but I wish the code snippets were easier to notice in their collapsed state. If you think you could draw more attention to them somehow that would be the next revision I would suggest.

LB-ArturZieba commented 1 year ago

I like the revisions that have been made. This is criticism of github markdown and not your work but I wish the code snippets were easier to notice in their collapsed state. If you think you could draw more attention to them somehow that would be the next revision I would suggest.

As an attempt to make the script dropdowns stand out, I have wrapped the script names in <mark> with in-line CSS to change the default color from yellow to blue (yellow was almost unreadable on this background) and <b>. Please let me know if there is a more appropriate way of implementing this effect.

michleza commented 1 year ago

I'm not familiar with other methods right now but I will do some quick research to see if anything appears. For now this should be fine though.

FuzzyCarter commented 1 year ago

@LB-ArturZieba, It looks like the expand overrides the color formatting on the github rendering.

image

A couple alternatives: Rename the "Area: Moving entity using Lua script" script: pattern to something like (Click to Expand) <filename>.lua

Additionally, these files could be all grouped together at the top under Docs in a new section called "Script Files". Or these could be put into an assets section for the workflow definition similar to what has been done in the animation graph creation workflow & Script an Actor with Animation Workflow

These solutions would require minor edits to the workflow text to be in-line with the changes, but would help with discoverability of the scripts, and you could even use the in-doc linking to link to the Script Files section for a user to quickly jump to where they need to be in the document to find the script file references.

LB-ArturZieba commented 1 year ago

@LB-ArturZieba, It looks like the expand overrides the color formatting on the github rendering.

image

A couple alternatives: Rename the "Area: Moving entity using Lua script" script: pattern to something like (Click to Expand) <filename>.lua

Additionally, these files could be all grouped together at the top under Docs in a new section called "Script Files". Or these could be put into an assets section for the workflow definition similar to what has been done in the animation graph creation workflow & Script an Actor with Animation Workflow

These solutions would require minor edits to the workflow text to be in-line with the changes, but would help with discoverability of the scripts, and you could even use the in-doc linking to link to the Script Files section for a user to quickly jump to where they need to be in the document to find the script file references.

Renamed the dropdowns as described and updated their relevant entries in the tables.

Added a section at the top of the file with links to all of the scripts, as well as a section with script link in each section that contains one.