Update AYON USD Docs and Add AYON USD Resolver Docs #238
Conversation
|
im not a 100% sure what i should do here ? |
I made this PR based on a discussion with @BigRoy where we agreed on creating two pages for USD Asset Resolver one for artists and one for admins. Feel free to push any commits to this PR, maybe we can discuss with BigRoy about what sections should be added. |
ah thanks for the info. |
It's also worth mentioning that APIs and resources are added in a dedicated PR #239 for the mentioned PR, I think it's fair to add a very basic short info about the USD resolver then we can create a follow up PR to enhance it. |
|
I agree that unless we have something to say, the artist resolver docs are not needed and more confusing than helping. the rest is fine |
|
Marking this PR as |
| (large) renderfarms to avoid the many resolves and server queries degrading | ||
| the server's performance. | ||
|
|
||
| **TODO** Explain how the pinning works technically and what env vars will be set to |
There was a problem hiding this comment.
@antirotor This I suppose would be in your hands. These are the admin facing docs.
| --- | ||
|
|
||
| Automatically contribute products into USD assets or shots | ||
|
|
||
| :::info |
There was a problem hiding this comment.
I think we should rather say that the Ayon contribution workflow was introduced around this time or its version, not this pr.
Reason:
many commits Created the Contribution workflow.
It might be confusing if you look at this one PR and don't see all the parts that made the contribution workflow.
| --- | ||
|
|
||
| import ReactMarkdown from "react-markdown"; | ||
| import versions from '@site/docs/assets/json/Ayon_addons_version.json' |
There was a problem hiding this comment.
This sounds like you need to configure every application while we bring a few defaults.
Maybe we should say, "Set up the LakeFs settings (currently because of the alpha version, etc.), and if you have a custom software version, add an alias to the "Main" Version."
Also, I just want to note that adding a new version is probably never needed, as we already bring all software packages that we have on lakeFs as defaults, so only an alias should be added.
| ``` | ||
| ayon+settings://maya/load/MayaUsdLoader/use_ayon_entity_uri | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Maybe we should add where you need to add the LakeFs keys?
### AyonUsd
ayon+settings://ayon_usd/lakefs/access_key_id
ayon+settings://ayon_usd/lakefs/secret_access_key
|
|
||
| ::: | ||
|
|
||
| ## Caching |
There was a problem hiding this comment.
There might be a point to mention that we don't do this for Deduplicaiont (Usd already does this internally) and also that the Cache is not bound to the Resolver class instance (If not explicitly requested via API) but lives as an instance shared cache.
I mention this because I talked about just that on the Usd forums, and it caused a bit of confusion before I explained it.
Changelog Description
This PR:
Testing notes:
Read through and let us know what do you think.