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

[DOCS] Atom components reference (properties) #717

Open
25 of 28 tasks
chanmosq opened this issue Jul 9, 2021 · 4 comments
Open
25 of 28 tasks

[DOCS] Atom components reference (properties) #717

chanmosq opened this issue Jul 9, 2021 · 4 comments
Labels
feature/atom This item is related to the ATOM and 3D rendering subsystems. kind/documentation Categorizes issue or PR as related to documentation. kind/reference Reference materials for users. RTE (Temp) Denotes an issue related to the Rev the Engine program WF5 This is a temporary label that will be removed once data conversion is complete

Comments

@chanmosq
Copy link
Contributor

chanmosq commented Jul 9, 2021

Describe the issue briefly

All of the Atom components reference pages (except for Light component) contain only a description. We need to update those pages to include a Properties section that details all of the properties of the component, and an image of the component from the Editor > Entity Inspector window.

Which page(s) / section(s) are affected?

Website: https://o3de.org/docs/user-guide/components/reference/
Files: user-guide/components/reference/atom/

  • Bloom
  • CubeMap Capture
  • Decal (Atom)
  • Debug Rendering (Level component)
  • Deferred Fog
  • Depth of Field
  • Diffuse Global Illumination (Level component)
  • Diffuse Probe Grid
  • Directional Light
  • Display Mapper (Level component)
  • Entity Reference
  • Exposure Control
  • Global Skylight (IBL)
  • Grid
  • HDR Color Grading
  • HDRi Skybox
  • Light
  • Look Modification
  • Material
  • Mesh
  • Occlusion Culling Plane
  • Physical Sky
  • PostFX Gradient Weight modifier
  • PostFX Layer
  • PostFX Radius Weight Modifier
  • PostFX Shape Weight Modifier
  • Reflection Probe
  • SSAO

Does this work have an engineering dependency? What is it?

Information for Atom components relies on the Atom team.

@chanmosq chanmosq added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jul 9, 2021
@sptramer sptramer added feature/atom This item is related to the ATOM and 3D rendering subsystems. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jul 12, 2021
@chanmosq
Copy link
Contributor Author

chanmosq commented Aug 17, 2021

@sptramer sptramer added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. kind/documentation Categorizes issue or PR as related to documentation. kind/reference Reference materials for users. RTE (Temp) Denotes an issue related to the Rev the Engine program WF5 This is a temporary label that will be removed once data conversion is complete and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Sep 27, 2021
@chanmosq chanmosq self-assigned this Oct 5, 2021
@FiniteStateGit
Copy link
Contributor

@chanmosq
Copy link
Contributor Author

Bloom component is in a PR: #1361

@chanmosq
Copy link
Contributor Author

HDRi Skybox component is in a PR: #1364

@chanmosq chanmosq removed their assignment Jan 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature/atom This item is related to the ATOM and 3D rendering subsystems. kind/documentation Categorizes issue or PR as related to documentation. kind/reference Reference materials for users. RTE (Temp) Denotes an issue related to the Rev the Engine program WF5 This is a temporary label that will be removed once data conversion is complete
Projects
Status: Backlog
Development

No branches or pull requests

3 participants