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

Features Grid Updates Process documentation #12759

Open
vincent6767 opened this issue Oct 21, 2022 · 4 comments
Open

Features Grid Updates Process documentation #12759

vincent6767 opened this issue Oct 21, 2022 · 4 comments
Assignees
Labels
sig/release Categorizes an issue or PR as relevant to SIG Release.

Comments

@vincent6767
Copy link

Features grid is part of the documentation we need to update on the release. This issue tracks the effort to document the process, so everyone understands

  1. What's the features grid?
  2. What's the purpose of the features grid?
  3. Where can I find it?
  4. How to update it?
  5. The ideal timeline for updating the features grid.
@vincent6767 vincent6767 self-assigned this Oct 21, 2022
@vincent6767 vincent6767 added the sig/release Categorizes an issue or PR as relevant to SIG Release. label Oct 21, 2022
@vincent6767
Copy link
Author

Documentation aimed at contributors.

  1. What's the features grid?
    1. A feature grid to allow members to understand the maturity and state of our documented and undocumented features. Currently being maintained by each SIG and published by the SIG docs community.
  2. What's the purpose of the features grid?
    1. Quoted from the original RFC
      1. The idea is so that a studio, company, developer, or member can look at this grid, and understand the state of the modules that are important to them. This also helps serve as a guide to where we need to focus our efforts and not duplicate work. The initially proposed tables are for Feature maturity, Code maturity, and Binary Maturity.
  3. Where can I find it?
    1. You can find the features grid in each release: Release Notes for Open 3D Engine - Open 3D Engine (o3de.org)
    2. Here is the repository for the feature grid: community/features at main · o3de/community · GitHub
  4. How to update it?
    1. You can see the instruction here: community/features at main · o3de/community · GitHub .
  5. What's the suggested process to update the O3DE release?
    1. The release manager creates issues in the release board, capturing the tasks for each SIG to update the features grid.
      1. The features grid should be completed at max one week before the release day.
    2. Each SIG updates the features grid and sends a PR, requesting approval from at least one SIG docs community member and their own SIG members.
    3. SIG member merges the PR.
    4. Once the features grid is completed, the release manager notifies the SIG Docs community to prepare for the feature grid updates.
    5. SIG docs community merged the features grid updates together with other documentation changes.

@vincent6767
Copy link
Author

@tonybalandiuk Please review. If it looks good to you, we can have this added to your release documentation

@FiniteStateGit
Copy link
Contributor

SIG-Docs-Community has an RFC in motion re: the feature grid as well: o3de/sig-docs-community#64.

@vincent6767
Copy link
Author

vincent6767 commented Nov 9, 2022

@FiniteStateGit Yep saw that. That will be more of the content as far as I understand. This issue tracks the process of updating the features grid near the release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sig/release Categorizes an issue or PR as relevant to SIG Release.
Projects
None yet
Development

No branches or pull requests

2 participants