chanmosq
commented
1 year ago 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 https://github.com/o3de/sig-docs-community/issues/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
o3deorganization, 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
o3deor theo3de-extrasrepository, only then can its docs live in the O3DE docs.
- Suggestion 1: If the project or Gem is part of the O3DE organization, meaning it's repository lives in the
Action items
- [ ] Discuss with other SIGs and TSC about how they want to handle external projects/Gems.
Meeting Details
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.
Open action items
Newly resolved items
Initial Agenda
The pre-approved agenda for this meeting is as follows:
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!
:+1: reactions to proposed agenda items are counted as YEA votes for taking up discussion, and :-1: 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:
Remember to add the :+1: and :-1: reactions manually, so they appear and are obvious to voters!