generated from cncf/hugo-netlify-starter
-
Notifications
You must be signed in to change notification settings - Fork 173
Open
Labels
help-wantedIssue that needs help from a contributor. Must meet help wanted guidelines.Issue that needs help from a contributor. Must meet help wanted guidelines.kind/content-architectureCategorizes issue as PR as related to the presented structure of documentation.Categorizes issue as PR as related to the presented structure of documentation.size/XXLDenotes a PR that changes 1000+ lines ignoring generated files.Denotes a PR that changes 1000+ lines ignoring generated files.
Description
Describe the issue
It does not have a hand-hold explanation that covers everything the dev needs to do. It covers only some of the necessary points, but there are too many gaps to cover.
- no mention of where to create the classes
- no mention of the #includes
- no mention of the cmake changes in case you create a new class
- no mention on how to call/use/execute the ebus on the component that "triggers"/"requests" the information
- use typedef instead of using (modern cpp)
Impacted page(s)
https://www.docs.o3de.org/docs/user-guide/programming/components/ebus-integration/
Expected experience
Any senior or junior dev, any student that is starting is degree or college student, can follow the tutorial and finish it. Hand-hold examples or "hello world" examples are a must.
Preliminary drafts:
- Draft 1: [ISSUE][DOCS] Components and EBuses page: Restructure #2712 (comment)
- Draft 2: [ISSUE][DOCS] Components and EBuses page: Restructure #2712 (comment)
- How to use tabs in the website: [ISSUE][DOCS] Components and EBuses page: Restructure #2712 (comment)
PR, coming soon:
- TODO
Parent is:
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
help-wantedIssue that needs help from a contributor. Must meet help wanted guidelines.Issue that needs help from a contributor. Must meet help wanted guidelines.kind/content-architectureCategorizes issue as PR as related to the presented structure of documentation.Categorizes issue as PR as related to the presented structure of documentation.size/XXLDenotes a PR that changes 1000+ lines ignoring generated files.Denotes a PR that changes 1000+ lines ignoring generated files.