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] Flesh out Engine Developer Guide #2587

Open
ShaunaGordon opened this issue Aug 26, 2024 · 3 comments
Open

[DOCS] Flesh out Engine Developer Guide #2587

ShaunaGordon opened this issue Aug 26, 2024 · 3 comments
Labels
documentation feature-need/important-longterm Feature: Important over the long term but may not be staffed May need multiple releases to complete kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. kind/website Categorizes an issue or PR as related to the website itself. priority/major Major priority. Work that should be handled after all blocking and critical work is done. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@ShaunaGordon
Copy link
Contributor

Describe the issue briefly

https://docs.o3de.org/docs/engine-dev/ is largely only stubs, which some sections not even having valid links. This entire section really needs some love. We can use this issue to help enumerate the specifics.

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

https://docs.o3de.org/docs/engine-dev/

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

There are probably some, technically, since this section is so expansive and there's always work going on on the engine, but I think that's not really an issue while we lay more of the foundation.

@ShaunaGordon ShaunaGordon added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. feature-need/important-longterm Feature: Important over the long term but may not be staffed May need multiple releases to complete kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. priority/major Major priority. Work that should be handled after all blocking and critical work is done. triage/accepted Indicates an issue or PR is ready to be actively worked on. kind/website Categorizes an issue or PR as related to the website itself. documentation labels Aug 26, 2024
ShaunaGordon added a commit to ShaunaGordon/o3de.org that referenced this issue Aug 26, 2024
…not yet exist.

Fixes o3de#2466

Signed-off-by: Shauna Gordon <[email protected]>

o3de#2587 added to address this page in the longer term.
@ShaunaGordon ShaunaGordon removed the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Aug 28, 2024
jhanca-robotecai pushed a commit that referenced this issue Sep 3, 2024
* Adjust old camera link to reference Viewport Manipulators, the closest in spirit to what the old link referenced. Fixes #2328

Signed-off-by: Shauna Gordon <[email protected]>

* Update blog link to go to EMotion FX page.

Fixes #2381

Signed-off-by: Shauna Gordon <[email protected]>

* Unlink dead links on engine dev home page. The content for them does not yet exist.

Fixes #2466

Signed-off-by: Shauna Gordon <[email protected]>

#2587 added to address this page in the longer term.

* Redirect user to Samples from Tutorials for the first project/getting started projects (such as Pong).

Fixes #2560

Signed-off-by: Shauna Gordon <[email protected]>

---------

Signed-off-by: Shauna Gordon <[email protected]>
@tkothadev
Copy link
Contributor

For the engine developer guide, do we have a mechanism for anchoring documentation to a release version of o3de? Trying to keep the guide up to date with the developer branch in my opinion would be a fruitless endeavor, as too much activity happens there.

Release cycle is slow enough that you could get enough meaningful documentation out, especially for things like AZFramework and Core, which are unlikely to change

@ShaunaGordon
Copy link
Contributor Author

We can, yeah. You can see that we're currently working on the 24.09 engine version (to release soon), and are cutting a version of the docs to correspond with it.

The way we work is that updates go to development by default, and while it's roughly in sync with the development version of the engine, "development" here also reflects the latest version of the docs themselves. We then cut branches that correspond to the versions of the engine, using the same process the engine repo uses, to "freeze" a copy of the docs to that version (it's not a hard freeze, since we can and do cherry-pick back as necessary).

I think, too, once we get a good foundation, keeping the development docs branch more in sync with the development engine branch will get easier, since then we're dealing more in changes, and less in wholesale synthesis.

@ShaunaGordon
Copy link
Contributor Author

I've created a Github project for this to help with enumerating the pages we need - https://github.com/orgs/o3de/projects/63/views/1 (projects are only visible to org members unfortunately, but it's better than nothing)

@github-staff github-staff deleted a comment from Lxx-c Oct 23, 2024
@github-staff github-staff deleted a comment from Lxx-c Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation feature-need/important-longterm Feature: Important over the long term but may not be staffed May need multiple releases to complete kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. kind/website Categorizes an issue or PR as related to the website itself. priority/major Major priority. Work that should be handled after all blocking and critical work is done. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

4 participants
@ShaunaGordon @tkothadev and others