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

[Planning] Ensure Docs-Community SIG requirements are identified #276

Closed
Naomi-Wash opened this issue May 20, 2024 · 6 comments
Closed

[Planning] Ensure Docs-Community SIG requirements are identified #276

Naomi-Wash opened this issue May 20, 2024 · 6 comments
Assignees

Comments

@Naomi-Wash
Copy link
Member

Work with the Docs-Community SIG to define requirements, and determine if any of the requirements will block the release if not completed prior to the release.

These requirements could include, for example,

  • Generate the C++ API reference for O3DE’s source code.
  • Finalize release notes.
  • Update Documentation versioning.
  • Update the website to display the correct version number.

A complete description of requirements can be found in the Docs Release Process Runbook.

  • Successor Task: (placeholder - confirm all launch blocking ...)
  • Successor Task: (placeholder - confirm all non-launch blocking ...)

Discord: #sig-docs-community
SIG Docs-Community meetings: O3DE Calendar
SIG Docs-Community agendas: GHI

@Naomi-Wash
Copy link
Member Author

@RoddieKieley Can you please review this GHI and update as you see fit given your experience updating docs during the last release? I want to make sure this is still an accurate release step. Thank you.

@Naomi-Wash
Copy link
Member Author

Include:

  • No Code Project documentation
  • Robotec.ai

@ShaunaGordon
Copy link
Collaborator

@Naomi-Wash I think @jhanca-robotecai has been taking point on the Robotec.ai stuff.

I don't know anything about the No Code Project documentation, though. Do you know who worked on that feature?

@ShaunaGordon
Copy link
Collaborator

ShaunaGordon commented Oct 4, 2024

Task list:

  • Create stabilization branch
    • Fix merge conflicts in stabilization branch
  • Update version dropdown in stabilization
    • Backport version dropdown update to previous versions
  • Update website to reflect new version
    • Update download link
  • Generate C++ API docs
    • Merge API docs update into stabilization
  • Finalize release notes
    • Create PR for release notes
  • Merge all branches in stabilization
    • Merge stabilization into main

@Naomi-Wash
Copy link
Member Author

Thanks @ShaunaGordon. You are correct about Robotec.ai owning the Ros elements, and @nick-l-o3de is on the No Code. (cc @Ulrick28).

@Naomi-Wash
Copy link
Member Author

@Naomi-Wash Pull Shauna's template into future release projects.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Planning - In Progress
Development

No branches or pull requests

3 participants