Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Load Asset LOP: Add Help section #55

Merged
merged 5 commits into from
Jul 30, 2024

Conversation

BigRoy
Copy link
Contributor

@BigRoy BigRoy commented Jul 29, 2024

Changelog Description

Implement a HELP page for the Lop Node

Additional info

Pressing the question mark in Houdini on the node will now show help information about the AYON Load Asset LOP.

I'm not sure how to 'embed' the AYON icon for the help section. @MustafaJafar or @fabiaserra do you know maybe? Using e.g. opdef:/ayon::Lop/lop_import::1.0?IconImage didn't seem to work.

Testing notes:

  1. Create the node.
  2. Press the question mark on the parameter window.

Here's an early screenshot:

image

@BigRoy BigRoy added documentation Improvements or additions to documentation type: enhancement Improvement of existing functionality or minor addition labels Jul 29, 2024
@BigRoy BigRoy requested a review from MustafaJafar July 29, 2024 18:40
@BigRoy
Copy link
Contributor Author

BigRoy commented Jul 29, 2024

Preferably we extend this section with GOTCHAS about the node - and also put a link to AYON USD documentation relevant to USD Houdini workflow when ynput/ayon-documentation#205 is implemented, merged and available online.

@BigRoy BigRoy self-assigned this Jul 29, 2024
…op_1lop__import_8_81.0/Help

Co-authored-by: Mustafa Taher <[email protected]>
Copy link
Contributor

@MustafaJafar MustafaJafar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I think we should gitignore backup

@BigRoy
Copy link
Contributor Author

BigRoy commented Jul 29, 2024

Also, I think we should gitignore backup

There may even be a way to force Houdini to not make backups for these HDAs.
See enableCreateBackup for the HDA definition: https://www.sidefx.com/docs/houdini/hom/hou/HDADefinition.html#updating-and-saving

That may be nicer even?

…op_1lop__import_8_81.0/Help

Co-authored-by: Mustafa Taher <[email protected]>
@MustafaJafar
Copy link
Contributor

Also, I think we should gitignore backup

There may even be a way to force Houdini to not make backups for these HDAs. See enableCreateBackup for the HDA definition: https://www.sidefx.com/docs/houdini/hom/hou/HDADefinition.html#updating-and-saving

That may be nicer even?

Will that affect the HDA on user machines after addon installation ?
Also, we will need to do that for every HDA ?

@MustafaJafar MustafaJafar self-requested a review July 30, 2024 07:39
@BigRoy
Copy link
Contributor Author

BigRoy commented Jul 30, 2024

Also, I think we should gitignore backup

There may even be a way to force Houdini to not make backups for these HDAs. See enableCreateBackup for the HDA definition: https://www.sidefx.com/docs/houdini/hom/hou/HDADefinition.html#updating-and-saving
That may be nicer even?

Will that affect the HDA on user machines after addon installation ? Also, we will need to do that for every HDA ?

No idea - I assume it's just a flag somewhere inside the HDA. Let me try it.

…op_1lop__import_8_81.0/Help

Co-authored-by: Mustafa Taher <[email protected]>
@MustafaJafar MustafaJafar self-requested a review July 30, 2024 08:54
Copy link
Contributor

@MustafaJafar MustafaJafar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested, It's awesome!

@BigRoy
Copy link
Contributor Author

BigRoy commented Jul 30, 2024

Lovely - I'll merge - we can tweak help section over time to improve more.

@BigRoy BigRoy merged commit 3255a8d into ynput:develop Jul 30, 2024
1 check passed
@BigRoy BigRoy deleted the enhancement/load_asset_lop_node_docs branch July 30, 2024 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation type: enhancement Improvement of existing functionality or minor addition
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants