Proposed SIG-Docs meeting agenda for 2022-09-13 about sig-docs-community

Hi,

It would also be great to keep the Discord moderators up to date so that we can give directions to people with these questions. Everythings gets lost today in the sea of messages thrown around at various channels.

We should get better to direct people into a Q&A forum. As much as I like chats to resolve occasional installation issues for persons X, Y and Z; they tend to be hard to search and find old information, unless you end up lucky asking the question in the same time zone a person is around to answer it.

Lumberyard used to have a forum where people could search and find things. I proposed in the past to open up a Stack Overflow for Teams where it can connect to Github as well as posting knowledge base stuff, Q&As, and all other kinds of functions that come along in that platform.

https://stackoverflow.co/teams/pricing
https://www.youtube.com/watch?v=MQxlE0ICumI

Sincerely,
Niklas

[willihay]

tl;dr: o3de.org needs clarification on what samples and tutorials can be included in the "learning-guide" part of the website: https://www.o3de.org/docs/learning-guide/.

The Contributor Guide topic on the website's docs structure is very specific about samples:

"The Samples section contains documentation for samples that are included with the O3DE distribution."

However, this raises the question why is the Kythera sample listed, since it is not included in the o3de repo? (It's available for download separately from a Kythera website.) Does the wording in the Contributor Guide need to be clarified?

The description for tutorials only talks about their assets, and not what tutorials are permitted:

"Tutorials should only use assets that are part of the O3DE distribution, are freely available, or can be quickly and easily replicated in open source content creation tools."

Perhaps what we need is an approval process whereby samples and tutorials can be approved to appear on the docs site.

We should also be clear about how much documentation can appear on o3de.org.

For samples, do we allow detailed and complete usage documentation on the site? Or do we limit content to something along the lines of a screenshot, a paragraph overview, and a link to the full set of usage docs that is expected to be hosted elsewhere?

For tutorials, what is permitted? Do we restrict tutorials to Gems that are included with o3de source? Or do we permit tutorials for remote projects and Gems if they've gone through an approval process?

A similar question applies to reference documentation for Gems that are not included in the o3de repo, although that might have additional concerns and a different timeline, and therefore require a separate discussion.

Decisions should be documented in the Contributor Guide.