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.

Sign up for GitHub

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

Jump to bottom

Initial rewrite of Editor and Viewport topics #2062

Merged
merged 6 commits into from
Nov 17, 2022
Merged

Initial rewrite of Editor and Viewport topics #2062

merged 6 commits into from
Nov 17, 2022

Conversation

FiniteStateGit
Copy link
Contributor

@FiniteStateGit FiniteStateGit commented Nov 3, 2022 •
edited
Loading

Deploy Preview: https://deploy-preview-2062--o3deorg.netlify.app/docs/user-guide/editor/

Change summary

  • Reorder and combine Editor topics
  • Rewrite 3D Viewport topics
  • Remove unused media

I'd like to redo some of the media when there are updated assets available to the project.

A view of the organization without drafts (which may show in the deploy preview):

3d-viewport-reorganization

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?

@FiniteStateGit
Initial rewrite of Editor and Viewport topics
2871e8b 
Signed-off-by: Jonathan Capes <j.capes@gmail.com>
@FiniteStateGit
remove media and textual edits
064cbef 
Signed-off-by: Jonathan Capes <j.capes@gmail.com>
@hultonha
Copy link
Contributor

hultonha commented Nov 8, 2022

Tagging @jonawals, @amzn-ahmadkrm and @AMZN-daimini for visibility as it would be great to get your feedback on this.

amzn-ahmadkrm
amzn-ahmadkrm approved these changes Nov 9, 2022
View reviewed changes
Copy link

@amzn-ahmadkrm amzn-ahmadkrm left a comment

Choose a reason for hiding this comment

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

The viewport page looks great!

jonawals
jonawals approved these changes Nov 9, 2022
View reviewed changes
Copy link
Contributor

@jonawals jonawals left a comment

Choose a reason for hiding this comment

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

Other than a nit, LGTM 8)

content/docs/user-guide/editor/viewport/advanced-operations.md Outdated Show resolved Hide resolved
content/docs/user-guide/editor/viewport/advanced-operations.md Outdated Show resolved Hide resolved
hultonha
hultonha approved these changes Nov 9, 2022
View reviewed changes
Copy link
Contributor

@hultonha hultonha left a comment

Choose a reason for hiding this comment

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

These doc updates are absolutely phenomenal @FiniteStateGit! 😄 It is genuinely a treat to read and will make such an incredibly difference for users on-boarding to O3DE (as well as those who use the editor every day but don't know about all these features). Incredible work and thank you so much for your help with this. My feedback is all minor nits really, overall things are looking fantastic! 😄

content/docs/user-guide/editor/console.md Show resolved Hide resolved
content/docs/user-guide/editor/customizing.md Outdated Show resolved Hide resolved
content/docs/user-guide/editor/customizing.md Outdated Show resolved Hide resolved
content/docs/user-guide/editor/editor-automation.md Show resolved Hide resolved
content/docs/user-guide/editor/entity-inspector.md Show resolved Hide resolved
content/docs/user-guide/editor/viewport/_index.md Show resolved Hide resolved
content/docs/user-guide/editor/viewport/_index.md Outdated Show resolved Hide resolved
content/docs/user-guide/editor/viewport/_index.md Outdated Show resolved Hide resolved
content/docs/user-guide/editor/viewport/_index.md Outdated Show resolved Hide resolved
content/docs/user-guide/editor/viewport/group-selection.md Outdated Show resolved Hide resolved
@FiniteStateGit
Address review feedback
b22d4b3 
Signed-off-by: Jonathan Capes <j.capes@gmail.com>
hultonha
hultonha approved these changes Nov 10, 2022
View reviewed changes
Copy link
Contributor

@hultonha hultonha left a comment

Choose a reason for hiding this comment

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

Thanks for making all the updates, looks awesome! 😄

AMZN-daimini
AMZN-daimini approved these changes Nov 10, 2022
View reviewed changes
Copy link
Contributor

@AMZN-daimini AMZN-daimini left a comment

Choose a reason for hiding this comment

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

It may be out of scope for this PR, but I noticed that some of the pages touched by this (namely the Entity Inspector, Customizing Editor Layout...) still have screenshots with the old Lumberyard UI instead of the new O3DE UI.

Some of the customization docs are also going to be obsolete soon, but that's definitely a separate concern I will bring up asap :)

micronAMZN
micronAMZN requested changes Nov 17, 2022
View reviewed changes
Copy link
Contributor

@micronAMZN micronAMZN left a comment

Choose a reason for hiding this comment

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

A couple minor issues.

content/docs/user-guide/editor/_index.md Outdated Show resolved Hide resolved
content/docs/user-guide/editor/console.md Show resolved Hide resolved
content/docs/user-guide/editor/console.md Outdated Show resolved Hide resolved
content/docs/user-guide/editor/viewport/_index.md Outdated Show resolved Hide resolved
content/docs/user-guide/editor/viewport/_index.md Outdated Show resolved Hide resolved
FiniteStateGit and others added 3 commits November 17, 2022 09:54
@FiniteStateGit @micronAMZN
Apply suggestions from code review
2dd9954 
Co-authored-by: Mike Cronin <58789750+micronAMZN@users.noreply.github.com>
Signed-off-by: Jonathan Capes <j.capes@gmail.com>
@FiniteStateGit @micronAMZN
Update content/docs/user-guide/editor/viewport/_index.md
99bc6d0 
Remove section topics

Co-authored-by: Mike Cronin <58789750+micronAMZN@users.noreply.github.com>
Signed-off-by: Jonathan Capes <j.capes@gmail.com>
@FiniteStateGit
Remove topics subsection
4699850 
Signed-off-by: Jonathan Capes <j.capes@gmail.com>
@micronAMZN micronAMZN merged commit d69520d into o3de:main Nov 17, 2022
@micronAMZN micronAMZN deleted the 3d-viewport branch November 17, 2022 18:38
@hultonha
Copy link
Contributor

Awesome work @FiniteStateGit!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jonawals jonawals jonawals approved these changes

@amzn-ahmadkrm amzn-ahmadkrm amzn-ahmadkrm approved these changes

@micronAMZN micronAMZN micronAMZN approved these changes

@hultonha hultonha hultonha approved these changes

@AMZN-daimini AMZN-daimini AMZN-daimini approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@FiniteStateGit @hultonha @micronAMZN @jonawals @AMZN-daimini @amzn-ahmadkrm