Skip to content

Update Rendering section in unreal docs#355

Closed
MustafaJafar wants to merge 5 commits into
mainfrom
354-update-unreal-render-setup-info-in-docs
Closed

Update Rendering section in unreal docs#355
MustafaJafar wants to merge 5 commits into
mainfrom
354-update-unreal-render-setup-info-in-docs

Conversation

@MustafaJafar
Copy link
Copy Markdown
Member

Changelog Description

resolve #354

Testing notes:

  1. Go through changes and approve if they make sense.

Copy link
Copy Markdown
Member

@LiborBatek LiborBatek left a comment

Choose a reason for hiding this comment

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

LGTM

PS. we will need to also update the user section in /docs/addon_unreal_artist#farm-rendering as its outdated. maybe just via link to the admin section??

@MustafaJafar
Copy link
Copy Markdown
Member Author

LGTM

PS. we will need to also update the user section in /docs/addon_unreal_artist#farm-rendering as its outdated. maybe just via link to the admin section??

OMG, this is way obsolete more than I thought 😅
https://ayon.ynput.io/docs/addon_unreal_artist#prerequisites-1
image

@MustafaJafar
Copy link
Copy Markdown
Member Author

@LiborBatek
I've added a note a bout farm rendering for users. let me know what do you think and feel free to merge.

Comment thread website/docs/addon_unreal_artist.md
AYON requires `Render Queue` and `Render Configuration` uassets to be physically present in the Unreal project.

By default they are expected at these paths:
By default, they are expected at these locations. To customize, see the note **Render Setup Settings** below:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
By default, they are expected at these locations. To customize, see the note **Render Setup Settings** below:
By default, they are expected in the following locations:

and you should move that second sentence of customizing to the Note itself instead...

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The second sentence is added to refer to the note below in case they want to customize it.
Does it look confusing ?

image

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

to me its a bit redundant as one can read it directly then within a Note itself imho... or at least should be placed just below the file paths examples for renderQueue and Config files...

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It could be, I think it worth it mentioning that this is configurable.

Comment thread website/docs/addon_unreal_admin.md Outdated
Comment thread website/docs/addon_unreal_admin.md Outdated
Comment thread website/docs/addon_unreal_admin.md Outdated
Comment thread website/docs/addon_unreal_admin.md Outdated
MustafaJafar and others added 2 commits March 19, 2025 11:42
Co-authored-by: Libor Batek <112623825+LiborBatek@users.noreply.github.com>
@moonyuet moonyuet requested a review from LiborBatek March 28, 2025 13:54
@moonyuet
Copy link
Copy Markdown
Member

any further update on this PR or it's good to merge?

Unreal integration also supports rendering on Deadline. The process for creating a render instance is the same as mentioned above, but you need to select `Farm Rendering` in `Render Target`.

Deadline rendering process expects physically existing Render Queue and Render Settings uassets in the Unreal project.
AYON requires `Render Queue` and `Render Configuration` uassets to be physically present in the Unreal project.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Actually these config files are mandatory also when local rendering happens...I guess we need to add it also at the begining of "Render Section" in the user docs or just move it there (single mentioning for both local/farm rendering)...

@LiborBatek
Copy link
Copy Markdown
Member

In the Artists Rendering section in

To render with AYON in Unreal, you will need to set a new root in AYON Project Settings. This root will be the folder where all the renders will be published.

we should adjust it to something like:

Prerequisites
To render using AYON integration for Unreal, you need to set a new root in AYON Project Settings first. This root will be used as a staging folder for intermediate rendered images which will be then integrated via publishing process.

@MustafaJafar
Copy link
Copy Markdown
Member Author

any further update on this PR or it's good to merge?

Just for reference, The docs are being migrated to featurebase. even if this PR is merged.
Most probably, artist and admins pages will be removed.

I'm including the information in this PR to feature base and we can continue polishing it there.

@MustafaJafar
Copy link
Copy Markdown
Member Author

@LiborBatek @moonyuet

I've included the changes in the PR to featurebase.
Feel free to check it there.

Copy link
Copy Markdown
Member

@moonyuet moonyuet left a comment

Choose a reason for hiding this comment

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

LGTM

@MustafaJafar
Copy link
Copy Markdown
Member Author

Changes in this PR were moved to our new help center, check them here https://help.ayon.app/collections/2313572-unreal
Since we are removing all artist and admin docs #370 , there's no point for having this PR any more.

@MustafaJafar MustafaJafar deleted the 354-update-unreal-render-setup-info-in-docs branch October 27, 2025 07:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update unreal render setup section

3 participants