Improve Prefab Overrides Docs #2506

AMZN-Gene · 2023-11-20T21:10:05Z

Change list:

Reworked the workflow to make it easier to read and follow. It now treats Prefab Overrides feature as a whole thing (previously the content is split in Outliner and Inspector, which is a detail for developers)
Added sub headers for "Types of overrides" and "Revert an override edit"
Added an overview description for prefab overrides
Improved the "Disable prefab overrides" section with more info and directed them to known issue lists and to create a new GHI

content/docs/learning-guide/tutorials/entities-and-prefabs/override-a-prefab.md

AMZN-Gene · 2023-11-20T21:39:10Z

content/docs/learning-guide/tutorials/entities-and-prefabs/override-a-prefab.md


 {{< note >}}
 A level is a prefab, and automatically enters Prefab Edit Mode when it is opened. This is indicated by the blue capsule around the level in **Entity Outliner**.

 Overrides are not limited to the level. In fact, any prefab that is open for editing in Prefab Edit Mode is responsible for storing the overrides made to its nested prefabs.
 {{< /note >}}

+However, if you do not want to make override changes, you should follow the old Prefab Edit Mode workflow instead. In the example, you can enter the mode on the Car instance before editing the Body entity, in which any changes will be applied to all Car instances as shown in the below image.


Suggested change

However, if you do not want to make override changes, you should follow the old Prefab Edit Mode workflow instead. In the example, you can enter the mode on the Car instance before editing the Body entity, in which any changes will be applied to all Car instances as shown in the below image.

If you do not want to make override changes, you should follow the old Prefab Edit Mode workflow instead. In this example, you can enter Prefab Edit Mode via the Car instance in the Entity Outliner. Any changes to Car will now affect all Car instances.

Love the paraphrasing!

content/docs/learning-guide/tutorials/entities-and-prefabs/override-a-prefab.md

AMZN-Gene · 2023-11-20T21:50:49Z

content/docs/learning-guide/tutorials/entities-and-prefabs/override-a-prefab.md


 {{< note >}}
-Once a property value is overridden to non-default value, the override edit can only be removed by doing a revert. In other words, setting the value back to default does not remove the override edit.
+If you see any unexpected overrides showing up, you can try the above methods to revert them. If it does not work out, you can open the prefab file that owns those overrides (under the `Instances` key) and remove the override patches you want.


pro-tip! <3

content/docs/learning-guide/tutorials/entities-and-prefabs/override-a-prefab.md

DCO Remediation Commit for Junhao Wang <wjunhao@amazon.com> I, Junhao Wang <wjunhao@amazon.com>, hereby add my Signed-off-by to this commit: 2b019f0 I, Junhao Wang <wjunhao@amazon.com>, hereby add my Signed-off-by to this commit: 025ac6a Signed-off-by: Junhao Wang <wjunhao@amazon.com>

forkercat

Approved by myself :)

Would like to wait for @alexmontAmazon's approval before merging.

alexmontAmazon

looks good to me, nice update!

Signed-off-by: Junhao Wang <wjunhao@amazon.com>

forkercat · 2023-11-21T00:00:05Z

Cannot see the page preview link. Double checked the image link and pushed a fix.

Ready to merge.

Merge pull request #2506 from o3de/wjunhao/improve-prefab-docs

* Updated development config.toml for 23.10 release. (#2488) Signed-off-by: Roddie Kieley <rkieley@redhat.com> * update the prefab override documentation now that it is on by default Signed-off-by: Alex Montgomery <alexmont@amazon.com> * Update content/docs/learning-guide/tutorials/entities-and-prefabs/override-a-prefab.md Co-authored-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> Signed-off-by: Alex Montgomery <alexmont@amazon.com> * changes per review Signed-off-by: Alex Montgomery <alexmont@amazon.com> * clarified new default settings Signed-off-by: Alex Montgomery <alexmont@amazon.com> * Improve Prefab Overrides Docs Merge pull request #2506 from o3de/wjunhao/improve-prefab-docs * Added 23.10.1 release notes. Signed-off-by: Roddie Kieley <rkieley@redhat.com> * Updated version information from 23.10.0 to 23.10.1 Signed-off-by: Roddie Kieley <rkieley@redhat.com> * Export Instructions for SDK/Installer (#2514) * Updating project export instructions to warn O3DE installer/SDK users. Installed versions of O3DE must use profile configuration and non-monolithic builds in order to package their game Signed-off-by: AMZN-Gene <genewalt@amazon.com> * Minor. Whitespace fix Signed-off-by: AMZN-Gene <genewalt@amazon.com> --------- Signed-off-by: AMZN-Gene <genewalt@amazon.com> * initial documentation updates for recent exporter changes for point release (#2519) * initial documentation updates for recent exporter changes for point release Signed-off-by: TJ Kotha <tankotha@amazon.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Gene Walters <32776221+AMZN-Gene@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * addressed feedback Signed-off-by: TJ Kotha <tankotha@amazon.com> * removed unnecessary warning for profile builds Signed-off-by: TJ Kotha <tankotha@amazon.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Gene Walters <32776221+AMZN-Gene@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * adding wildcard documentation for seed parameters Signed-off-by: TJ Kotha <tankotha@amazon.com> * splitting argument table into separate unique entries Signed-off-by: TJ Kotha <tankotha@amazon.com> * minor sentence improvement Signed-off-by: TJ Kotha <tankotha@amazon.com> * minor sentence improvements Signed-off-by: TJ Kotha <tankotha@amazon.com> * split up snippets into smaller sections Signed-off-by: TJ Kotha <tankotha@amazon.com> --------- Signed-off-by: TJ Kotha <tankotha@amazon.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> Co-authored-by: TJ Kotha <tankotha@amazon.com> Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com> Co-authored-by: Gene Walters <32776221+AMZN-Gene@users.noreply.github.com> * adding important addendum to using the project export functionality Signed-off-by: TJ Kotha <tankotha@amazon.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Updated release date from December 7 to December 14. Signed-off-by: Roddie Kieley <rkieley@redhat.com> * Update installing-linux.md - opt version format change Signed-off-by: Roddie Kieley <rkieley@redhat.com> * Update config.toml for 23.10.1 Signed-off-by: Roddie Kieley <rkieley@redhat.com> * fix the typo (#2547) Signed-off-by: kursad-k <67970138+kursad-k@users.noreply.github.com> * Backport #2551 Unclear if #2551 can be directly backported, so this adds instructions to manually add the missing WarehouseAutomation gem Signed-off-by: Nathan Brooks <nathanbrooks@picknik.ai> --------- Signed-off-by: Roddie Kieley <rkieley@redhat.com> Signed-off-by: Alex Montgomery <alexmont@amazon.com> Signed-off-by: AMZN-Gene <genewalt@amazon.com> Signed-off-by: TJ Kotha <tankotha@amazon.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> Signed-off-by: kursad-k <67970138+kursad-k@users.noreply.github.com> Signed-off-by: Nathan Brooks <nathanbrooks@picknik.ai> Co-authored-by: Roddie Kieley <rkieley@redhat.com> Co-authored-by: Alex Montgomery <alexmont@amazon.com> Co-authored-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> Co-authored-by: Gene Walters <32776221+AMZN-Gene@users.noreply.github.com> Co-authored-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> Co-authored-by: TJ Kotha <tankotha@amazon.com> Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com> Co-authored-by: colinb[APMG] <68035668+byrcolin@users.noreply.github.com> Co-authored-by: kursad-k <67970138+kursad-k@users.noreply.github.com>

Improve prefab overrides docs

2b019f0

AMZN-Gene requested a review from a team as a code owner November 20, 2023 21:10

AMZN-Gene commented Nov 20, 2023

View reviewed changes

forkercat requested review from forkercat, AMZN-daimini and alexmontAmazon November 20, 2023 23:23

forkercat reviewed Nov 20, 2023

View reviewed changes

content/docs/learning-guide/tutorials/entities-and-prefabs/override-a-prefab.md Outdated Show resolved Hide resolved

forkercat added 2 commits November 20, 2023 15:37

Address feedback on the first draft

025ac6a

forkercat approved these changes Nov 20, 2023

View reviewed changes

alexmontAmazon approved these changes Nov 20, 2023

View reviewed changes

Fix invalid image link

8b2fb69

Signed-off-by: Junhao Wang <wjunhao@amazon.com>

forkercat merged commit fbd03f5 into stabilization/23101 Nov 21, 2023
1 check passed

forkercat deleted the wjunhao/improve-prefab-docs branch November 21, 2023 19:32

jhanca-robotecai pushed a commit that referenced this pull request Jul 4, 2024

Improve Prefab Overrides Docs

2567afa

Merge pull request #2506 from o3de/wjunhao/improve-prefab-docs

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve Prefab Overrides Docs #2506

Improve Prefab Overrides Docs #2506

AMZN-Gene commented Nov 20, 2023 •

edited by forkercat

Loading

AMZN-Gene Nov 20, 2023

forkercat Nov 20, 2023

AMZN-Gene Nov 20, 2023

forkercat left a comment

alexmontAmazon left a comment

forkercat commented Nov 21, 2023 •

edited

Loading

	However, if you do not want to make override changes, you should follow the old Prefab Edit Mode workflow instead. In the example, you can enter the mode on the Car instance before editing the Body entity, in which any changes will be applied to all Car instances as shown in the below image.
	If you do not want to make override changes, you should follow the old Prefab Edit Mode workflow instead. In this example, you can enter Prefab Edit Mode via the Car instance in the Entity Outliner. Any changes to Car will now affect all Car instances.

Improve Prefab Overrides Docs #2506

Improve Prefab Overrides Docs #2506

Conversation

AMZN-Gene commented Nov 20, 2023 • edited by forkercat Loading

AMZN-Gene Nov 20, 2023

Choose a reason for hiding this comment

forkercat Nov 20, 2023

Choose a reason for hiding this comment

AMZN-Gene Nov 20, 2023

Choose a reason for hiding this comment

forkercat left a comment

Choose a reason for hiding this comment

alexmontAmazon left a comment

Choose a reason for hiding this comment

forkercat commented Nov 21, 2023 • edited Loading

AMZN-Gene commented Nov 20, 2023 •

edited by forkercat

Loading

forkercat commented Nov 21, 2023 •

edited

Loading