Proposed SIG-Docs meeting agenda for 2022-12-13

[chanmosq]

Meeting Details

• Date/Time: December 13, 2022 @ 10:30 10:30am PT
• Location: Discord SIG-Docs Voice Room
• Moderator: @chanmosq
• Note Taker: Name

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

SIG Updates

What happened since the last meeting? - The creator of this issue is responsible for providing a brief summary here to be used as an update to start any important discussions.

• docs.o3de.org domain has been removed (Remove docs.o3de.org subdomain #83)
• Initial PR for the Engine Developer Guide (Addition of Engine Developer Guide topic and structure stubs o3de.org#2162)
• New codeowners file in o3de.org
• Revised Documentation and Community Roles and created new nomination forms.
  • Website Reviewers: A new reviewers team specifically for website.
  • Community Specialist: A team specifically for community-related content.
  • Technical Reviewers: Technical docs reviewers are SIG-specific, and each SIG may decide how to manage this group.

Open action items

• Proposed RFC: Introduce developer documentation for the Action Manager system #88
  See https://github.com/orgs/o3de/projects/15/views/1.

Newly resolved items

• ✅ Engine Developer Guide RFC #73

Initial Agenda

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

• Agenda item name - Presenter - Length of time
  • Description of the item
• ...

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]

Meeting notes

Engine Developer Guide - next steps

Determine general direction for information architecture of the docs. We may want to discuss with technical SIGs about how we want to organize the information. Because this guide will develop overtime and has minimal docs to start out with, the information architecture plan should be simple and scalable. We just need to have enough direction such that contributors have a place to put their docs and users can find them.

Action items

• Discuss with other technical SIGs and establish general guidelines on information architecture.

Clarification on what documentation can be included in o3de.org #72

• There will be tutorials for the Multiplayer Sample Project (MSP), and it's uncertain whether these docs should live in o3de.org/docs.
  • Option 1: Docs live in o3de.org/docs.
  • Option 2: Docs live in their project's repository, and the o3de.org/docs links to them.
• Discussion 1: From the user's perspective, it's easier to find docs when they are in o3de.org/docs. As a user, being able to see the MSP docs in the O3DE Docs helps bring visibility to the project. Also, the MSP's tutorials can be more easily searchable through O3DE Docs's search, which as an example can help users find information on how to use networking features.
  • This argument favors option 1.
• Discussion 2: If we decide on something for MSP docs, we must also consider what we want to do about docs for other external projects or Gems. If MSP docs live in o3de.org/docs, then what about other projects? O3DE Docs can't host every contribution, so what do we do about those docs?
  • This concern leads to the consideration of option 2.
• Per discussion 2, the open question is, what is the dividing line for determines whether a docs set should be hosted by O3DE Docs or not? How can we standardize these requirements so that we can provide direction on what docs to include in O3DE Docs as O3DE scales and we get more contributions? Some examples that this impacts are the AWS Gems and the Kythera AI Gem.
  • Suggestion 1: If the project or Gem is part of the O3DE organization, meaning it's repository lives in the o3de organization, then its docs can live in the O3DE docs.
  • Suggestion 2: If the project or Gem ships with the O3DE source, meaning it's included in either the o3de or the o3de-extras repository, only then can its docs live in the O3DE docs.

Action items

• Discuss with other SIGs and TSC about how they want to handle external projects/Gems.