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

prefab override clarifications and updates #2496

Merged
merged 2 commits into from
Oct 19, 2023

Conversation

alexmontAmazon
Copy link
Contributor

Change summary

Clarified and expanded the prefab override documentation

Submission Checklist:

  • Descriptive active voice - Do descriptive sentences have a clear subject and action verb?
  • Answer the question at hand - Does the documentation answer a what, why, how, or where type of question?
  • Consistency - Does the content consistently follow the Style Guide?
  • Help the user - Does the documentation show the user something meaningful?

Signed-off-by: Alex Montgomery <alexmont@amazon.com>

```JSON
{
"O3DE": {
"Autoexec": {
"ConsoleCommands": {
"ed_enableOutlinerOverrideManagement": true
"ed_enableDPEInspector": true,
"ed_enableInspectorOverrideManagement": true
}
}
}
Copy link
Contributor

@forkercat forkercat Oct 18, 2023

Choose a reason for hiding this comment

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

I think we should remove line 58 - 62. The info is outdated.

Comment on lines 42 to 43
To enable prefab overrides in Entity Outliner, you must set the `ed_enableOutlinerOverrideManagement` console variable (CVar) to "true". Although you *can* set this in the **Console Variables Editor**, this feature is not currently changeable
while the Editor is running, so it must be set before the Editor starts, via a settings registry file. You should create a settings registry file with the following contents:
while the Editor is running, so it must be set before the Editor starts, via a settings registry file. You will also want to enable the `ed_enableInspectorOverrideManagement` flag, so that you can edit overrides in the Inspector. You should create a settings registry file with the following contents:
Copy link
Contributor

@forkercat forkercat Oct 18, 2023

Choose a reason for hiding this comment

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

Should we include only prefab overrides in outliner in this section? We have a section below to enable prefab overrides in inspector.

Suggest changing to:

To enable prefab overrides in Entity Outliner, you must set the ed_enableOutlinerOverrideManagement console variable (CVar) to "true". Although you can set this in the Console Variables Editor, this feature is not currently changeable while the Editor is running. Therefore, it must be set before the Editor starts, via a settings registry file:

{
    "O3DE": {
        "Autoexec": {
            "ConsoleCommands": {
                "ed_enableOutlinerOverrideManagement": true
            }
        }
    }
}

{{< note >}}
It is recommended to add your settings registry file to the <project-path>/user/Registry directory as a user-specific override. Files in the user directory are ignored by git and won't be tracked for changes.
{{< /note >}}

To enable prefab overrides in Inspector, you will also want to enable the ed_enableInspectorOverrideManagement flag so that you can edit overrides in the Inspector. Please see the section [[Prefab overrides in Entity Inspector]] below for more info.


I am open to move the ed_enableInspectorOverrideManagement section up here and reorganize the contents in the doc, which I think it makes it clearer for users who want to try out all the override features at once. Let me know if you need my help on this.

@forkercat
Copy link
Contributor

When this doc is out, are the two override flags and DPE flag already enabled by default?

Copy link

@rainbj rainbj left a comment

Choose a reason for hiding this comment

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

Approval from Sig-UX-UI. Changes are great. FYI This is not a code review

Signed-off-by: Alex Montgomery <alexmont@amazon.com>
@alexmontAmazon alexmontAmazon merged commit b7fe90c into o3de:main Oct 19, 2023
5 checks passed
@alexmontAmazon alexmontAmazon deleted the alexmont/main branch October 19, 2023 20:22
Copy link
Contributor

@forkercat forkercat left a comment

Choose a reason for hiding this comment

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

lgtm

jhanca-robotecai pushed a commit that referenced this pull request Dec 22, 2023
prefab override clarifications and updates
jhanca-robotecai pushed a commit that referenced this pull request Jul 4, 2024
prefab override clarifications and updates
jhanca-robotecai pushed a commit that referenced this pull request Aug 16, 2024
prefab override clarifications and updates

Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>
jhanca-robotecai added a commit that referenced this pull request Aug 22, 2024
* Quick fix - Made documentation be the landing page

Signed-off-by: chanmosq <75444793+chanmosq@users.noreply.github.com>

* Windows offline installer instructions (#2445)

* Add the offline installer instructions for Windows

Signed-off-by: Mike Chang <changml@amazon.com>

* Update linux and snap package instructions (#2462)

Update system requirements link and clarify snap instructions

Signed-off-by: Mike Chang <changml@amazon.com>

* Update code-of-conduct.md (#2469)

* Update code-of-conduct.md

Removed mentions of CNCF

Signed-off-by: Naomi Washington <70667788+Naomi-Wash@users.noreply.github.com>

* Update code-of-conduct.md

Removed now extraneous line regarding other languages.

Signed-off-by: Roddie Kieley <rkieley@redhat.com>

---------

Signed-off-by: Naomi Washington <70667788+Naomi-Wash@users.noreply.github.com>
Signed-off-by: Roddie Kieley <rkieley@redhat.com>
Co-authored-by: Roddie Kieley <rkieley@redhat.com>

* Merge pull request #2475 from o3de/stabilization/2310

Stabilization/2310

Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>

* Merge pull request #2491 from RoddieKieley/2310-main-release-notes

Added 23.10 release notes.

Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>

* Merge pull request #2492 from aws-lumberyard-dev/alexmont/main

Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>

* Merge pull request #2496 from aws-lumberyard-dev/alexmont/main

prefab override clarifications and updates

Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>

* Merge pull request #2512 from o3de/stabilization/23101

Stabilization/23101 -> main for publishing

Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>

* fix diff between main and development

Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>

* 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>
Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>

* 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>

* Merge pull request #2513 from RoddieKieley/stabilization/23101

Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>

* Added 23.10.1 release notes.

Signed-off-by: Roddie Kieley <rkieley@redhat.com>

* fix the typo (#2547)

Signed-off-by: kursad-k <67970138+kursad-k@users.noreply.github.com>

* Updated for the 23.10.3 point release.

Signed-off-by: Roddie Kieley <rkieley@redhat.com>

* Merge pull request #2552 from guillaume-haerinck/samples

Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>

* fix merge conflicts

Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>

* adding documentation for the new export button (#2578)

* adding documentation for the new export button

Signed-off-by: TJ Kotha <tankotha@amazon.com>

* addressing feedback round 1

Signed-off-by: TJ Kotha <tankotha@amazon.com>

* updating screenshots

Signed-off-by: TJ Kotha <tankotha@amazon.com>

---------

Signed-off-by: TJ Kotha <tankotha@amazon.com>
Co-authored-by: TJ Kotha <tankotha@amazon.com>
Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>

---------

Signed-off-by: chanmosq <75444793+chanmosq@users.noreply.github.com>
Signed-off-by: Mike Chang <changml@amazon.com>
Signed-off-by: Naomi Washington <70667788+Naomi-Wash@users.noreply.github.com>
Signed-off-by: Roddie Kieley <rkieley@redhat.com>
Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>
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>
Co-authored-by: chanmosq <75444793+chanmosq@users.noreply.github.com>
Co-authored-by: Mike Chang <changml@amazon.com>
Co-authored-by: Naomi Washington <70667788+Naomi-Wash@users.noreply.github.com>
Co-authored-by: Roddie Kieley <rkieley@redhat.com>
Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com>
Co-authored-by: Alex Montgomery <alexmont@amazon.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: kursad-k <67970138+kursad-k@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants