Proposed SIG-Docs meeting agenda for 2022-11-08

[chanmosq]

Meeting Details

• Date/Time: November 8, 2022 @ 10:30 am PT
• Location: Discord SIG-Docs Voice Room
• Moderator: @chanmosq
• Note Taker: @sptramer

The SIG-Docs Meetings contains the history past calls, including a link to the agenda, recording, notes, and resources.

Agenda

The pre-approved agenda for this meeting is as follows:

• SIG Updates
• See the remaining agenda items in the comments below.

SIG Updates

What happened since the last meeting?

• The last meeting took place onsite at O3DCon 2022. There we discussed some open RFCs, the discussions are placed in the RFC issues themselves. No RFCs have been accepted since then, but some activity from reviewers has occurred.
• From TSC, discussions about general planning across all SIGs.
  • April 2023 Release Planning
  • All SIGs are putting together a roadmap. (One of our agenda items to discuss.)
• From TSC, o3de/o3de-extras repository will continue to grow and may require maintenance from all sigs.

Open action items

See O3DE - Docs and Community Roadmap (view).

Newly resolved items

The following RFCs were accepted during the meeting:

• Proposed RFC: Merge access control and designated ownership of o3de/o3de.org #61
• Proposed RFC: Documentation reporting on the Feature Grid #64

Suggesting and voting on agenda items

Our community is welcome to suggest and vote on agenda items. If you suggest an item you need to have a designated presenter (normally the issue filer), but any community member can vote and isn't required to attend meetings or even participate in further discussion. If you think something is a good idea to discuss for the O3DE community, please upvote!

👍 reactions to proposed agenda items are counted as YEA votes for taking up discussion, and 👎 as NAY. Votes on items don't determine the final agenda, but do influence it and are strongly taken into consideration as a representation of what the O3DE community wants to see from the project.

Agenda item format

If you leave a comment on this issue to propose an agenda item, please use the following format:

**Topic**: The topic you'll be presenting on
**Presenter**: Who will present (may be a team name or TBD)
**Length of time**: Estimate the amount of time you believe discussion will take. This should not be more than 15 minutes without SIG approval.

Include a description of your topic. Make sure to link to any supplementary materials such as RFCs, forum discussions, issues, etc.

Remember to add the 👍 and 👎 reactions manually, so they appear and are obvious to voters!

[chanmosq]

Topic: Proposal to change PR review process so that the required approvals for a PR to merge is 1 docs + 1 tech reviewer, as opposed to 2 docs reviewers.
Presenter: @chanmosq
Length of time: 5 minutes

RFC work in progress: #70

[chanmosq]

Topic: TSC - Roadmap
Presenter: @chanmosq
Length of time: At least 30 mins
The TSC is gathering material from each sig to construct roadmap for the next release. The purpose is to communicate better with community and to have a general understanding of where the product is moving towards.

Let's have a discussion for what a roadmap for docs might look like. We are welcoming all roadmap item proposals. This will essentially be a brainstorm session. Our roadmap items may include:

• Feature docs to support other SIGs. These items are directly dependent on other SIGs roadmap and will require cross-sig communication.
• Research and development tasks to improve the state of the o3de.org/docs. This may include information architecture, docs-specific website updates, etc.
• To be discussed

@aFinchy Let's also discuss what this might look like from a community perspective.

[chanmosq]

Proposal to move sig-docs-community triage to Tuesday 10-10:30. This way, every two weeks, issue triage and sig meeting would simply line up, and effectively making Wednesday free of sig matters.

Alternate proposal, adjust the time for both meetings biweekly meeting happens first, and then issue triage. The schedule would look like:

• 10-11 am PT: Biweekly meeting
• 11-11:30 am PT: Issue triage

The benefit of this is that if issue triage is short, ending early won't create a strange gap between the two meetings or consequently cause us to begin biweekly meeting before the allotted time. It's important for biweekly meeting to be on time for folks who want to join biweekly meeting only.

---

UPDATE: Per meeting, due to conflict with sig chair, we will delay the proposed meeting time by 30 minutes.
The agreed new time is

• 10:30-11:30 am PT: Biweekly meeting (No change here, this is the same time it currently is.)
• 11:30-12 pm PT: Issue triage

[sptramer]

Topic: Forthcoming RFC - "Engine Developer Guide"
Presenter: Stephen Tramer
Length of time: 5m

It didn't make it in time for this meeting, but there is a fully revised draft of a proposal for an "Engine Developer Guide", focused on getting engineering information about the project into an authoritative source. This RFC is likely to be posted before 11/11. Would like to request an expedited review period when the RFC is posted due to the urgency of the requests from engineers for this sort of information repository.

[sptramer]

Meeting notes:

• Set up project board for handling open action items from previous meetings: O3DE - Docs and Community Roadmap

• Feature grid update:

  • Request from Pip on Proposed RFC: Documentation reporting on the Feature Grid #64 - Feedback to be addressed later in this meeting during discussion

• Linux Foundation had some followup questions on Proposed RFC: Merge access control and designated ownership of o3de/o3de.org #61 - They must have reviewed it. We can move forward with the proposed plan, providing documentation, CODEOWNERS, etc.

  • Need to create work items coming out of here:
    • Setting up the original website maintainers CODEOWNERS
    • Draft reviewer/maintainer requirements for new review groups
    • Communicate out what these changes mean to sig-all

• Automated style check and broken link checking may be removed.

• Linux Foundation needs to remove docs.o3de.org as a subdomain.

  • Issue to be created in o3de.org repo - @FiniteStateGit to investigate and determine how we may need to handle, will be assigned to @OBWANDO for LF involvement as our primary point of contact.

• What documentation can appear on o3de.org?

  • We will need to remove partner documentation (AWS, Kythera) off of o3de.org at some point.
  • The proposal here is focused on Proposed SIG-Docs meeting agenda for 2022-09-13 #60 (comment) - How can we get tutorials into the o3de.org site?
  • Suggstions:
    • External link index for validated 3rdparty Gems, including links to their docs
    • Blog posts might work best for tutorializing these tools? Allows for 3rd parties (including interested community members) to write an overview/runthrough of how to use an O3DE-related product that we would like to highlight.
    • Main concern: "Where does the content live? How would people find it?"
    • @sptramer to reach out to Kythera about the documentation for their tutorial - we would like to move it off the website and onto their site. If we need justification, we can reach for the TSC. Other paths are welcome for suggestion.
    • Should work with the TSC to figure out the separation of concerns and draft a possible RFC for definition of "core distributable".
    • We also have a extras repository: https://github.com/o3de/o3de-extras/ - Can contain samples and assets which we create. Currently hosting XR Gem and remote templates. (Clarify repo where new Gems contributed to o3de should be added (o3de vs o3de-extras) tsc#57)
    • Also have Game Jam games, Robotics demos, etc. These are going to be hosted in the O3DE repo.

• Changing the PR review process! +1 docs reviewer, +1 tech reviewer.

  • Ensuring that the right PRs get the right reviews from the right people means we should reduce the reviewer restriction workload. RFC forthcoming from Chanelle for voting.

• stramer filing Engine Developer Guide RFC this week - proposing a 1wk review period to beat the holiday season and give enough time for feedback on this critical item.

• Roadmaps!

  • Things on our backlog we would like to address
  • Things we know we will be doing for the next release
  • Things we have RFCs accepted for but no implementation behind
    • Website versioning (Willow)
    • Game jams? Content jams? Blog post pipelines? (Amy)
      • Keep focused on o3de.org, not on the LF
      • The tricky part here is where there are planned delivery dates, which then get missed. Target a reasonable number of posts / topics as our target.
      • Maybe break into generalized categories (content, development, user stories) rather than a number of "X blog posts"?
      • Conversion guides for Unreal and Unity to O3DE
      • Interactive tutorials! There is an RFC for incorporating interactive tutorials; We would like to deliver at least some initial content. Proposed: 4-6 tutorials. We already have some demo content from the tool development period.

• Feature grid stuff:

  • See comments on issue.
  • Provisionally accepted with the understanding that we need to establish a system of metrics for evaluating the quality.