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

[ISSUE][DOCS] Docs landing page should provide information about what "main" version is #1834

Closed
lmbr-pip opened this issue Jul 22, 2022 · 1 comment · Fixed by #2087
Closed
Assignees
Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/critical Critical priority. Must be actively worked on as someone's top priority right now. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@lmbr-pip
Copy link
Contributor

lmbr-pip commented Jul 22, 2022

Describe the issue

Theres no indication on https://www.o3de.org/docs/ what version the docs refer to. Users have to know the convention to understand how to read these docs.

There should be a clear call out about what engine version pages are referencing.

Note: Documentation is for the xx.xx version of O3DE. For previous versions go here.

Would also like a callout to bleeding edge developer documentation here to.

Impacted page(s)

https://www.o3de.org/docs/

Expected experience

  • Docs is very clear about what version of the engine they are for.

Hopefully covered in existing issues:

  • We have a link to developer docs on this page so folks working in GitHub get access to latest docs.
  • We have links to previous release versions of the engine ie 2205, 2110 etc, so I can find the most relevant docs for the engine version I am using ([SITE][FEATURE] Need a away to version documentation #1289)
@lmbr-pip lmbr-pip added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jul 22, 2022
@sptramer sptramer added priority/major Major priority. Work that should be handled after all blocking and critical work is done. priority/critical Critical priority. Must be actively worked on as someone's top priority right now. and removed priority/major Major priority. Work that should be handled after all blocking and critical work is done. labels Jul 27, 2022
@sptramer
Copy link
Contributor

Should be addressed as part of versioning RFC o3de/sig-docs-community#46

@sptramer sptramer added kind/documentation Categorizes issue or PR as related to documentation. triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jul 27, 2022
@willihay willihay self-assigned this Nov 9, 2022
@willihay willihay linked a pull request Nov 17, 2022 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/critical Critical priority. Must be actively worked on as someone's top priority right now. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants