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

[DOCS] Getting Started doc(s) for the Multiplayer Sample project #1632

Closed
chanmosq opened this issue May 12, 2022 · 6 comments
Closed

[DOCS] Getting Started doc(s) for the Multiplayer Sample project #1632

chanmosq opened this issue May 12, 2022 · 6 comments
Labels
feature/networking This item is related to the client or server network code. kind/feature Categorizes issue or PR as related to a new feature. priority/critical Critical priority. Must be actively worked on as someone's top priority right now. rfc-feature RTE (Temp) Denotes an issue related to the Rev the Engine program sig/docs-community Categorizes an issue or PR as relevant to SIG Docs-Community. triage/declined Indicates an issue is not accepted WF6 This is a temporary label that will be removed once data conversion is complete

Comments

@chanmosq
Copy link
Contributor

chanmosq commented May 12, 2022

Describe the issue briefly

Would like to have a Getting Started guide to compliment the Multiplayer Sample project (MSP), which users can download and play around with.

Some questions to address may be

  • What's a quick explanation of the intent of this project and its core features
  • What are the simplest steps to install and set up the provided sample project. (Should user start with a blank project, or download the MSP? Any Gems to build with?)
  • What are the most important questions new users will have?
  • What are cool things users can do with this project?

Requests to include in this doc

  • Add as a prerequisite what the most stable version of O3DE to use with this project.
  • Usage of CVARs and .cfg files. Can reference the CVAR docs in "Related topics".

Which page(s) / section(s) are affected?

The document should live in https://www.o3de.org/docs/learning-guide/tutorials/multiplayer/. We may need to split this to multiple pages.

Does this work have an engineering dependency? What is it?

Depends on knowledge of O3DE's networking features, and preferably knowledge from developer of project.

@chanmosq chanmosq added RTE (Temp) Denotes an issue related to the Rev the Engine program WF6 This is a temporary label that will be removed once data conversion is complete labels May 12, 2022
@chanmosq chanmosq reopened this May 12, 2022
@chanmosq
Copy link
Contributor Author

chanmosq commented May 12, 2022

This task relates to #919 and #1318, as documentation on the MSP may reference Multiplayer docs .

@chanmosq chanmosq added feature/networking This item is related to the client or server network code. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 12, 2022
@ghost ghost added kind/feature Categorizes issue or PR as related to a new feature. priority/major Major priority. Work that should be handled after all blocking and critical work is done. labels May 16, 2022
@sptramer sptramer added triage/declined Indicates an issue is not accepted rfc-feature and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 18, 2022
@sptramer
Copy link
Contributor

sptramer commented May 18, 2022

Declined for the following reasons:

  • Multiplayer sample is not distributed as part of core O3DE, and is a separately maintained example project. It can be index on the website, but any instructions for the project itself must be self-contained documentation, ideally README.md.
  • There is a forthcoming RFC to create a specific SIG for the maintenance of supplementary projects such as this one, to keep docs sig and the website from becoming overloaded/crowded.

@o3de/sig-ui-ux @o3de/sig-network - Tagged due to relevance of current MSP ownership and RTE tracking.

@lmbr-pip
Copy link
Contributor

lmbr-pip commented May 19, 2022

IMHO:

  • READMEs cannot hold complex documentation, users do not read them anecdotally
  • Repo wikis are hard to use because theres no process to make PRs, review changes and push them, which means that theres no valid collaboration flow that the community can own.

Also please link to RFC or public roadmap item for RFC otherwise, we should have a public item that we are punting to.

@yuyihsu yuyihsu added priority/critical Critical priority. Must be actively worked on as someone's top priority right now. and removed priority/major Major priority. Work that should be handled after all blocking and critical work is done. labels May 20, 2022
@yuyihsu
Copy link
Contributor

yuyihsu commented May 20, 2022

this was defined as critical in the post-RTE discussion.

@yuyihsu yuyihsu added the sig/docs-community Categorizes an issue or PR as relevant to SIG Docs-Community. label May 20, 2022
@sptramer
Copy link
Contributor

Just because the website isn't the appropriate place for it, and this isn't the correct way to address the problem, doesn't mean it isn't critical.

@sptramer
Copy link
Contributor

Closed in favor of o3de/o3de-multiplayersample#174

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature/networking This item is related to the client or server network code. kind/feature Categorizes issue or PR as related to a new feature. priority/critical Critical priority. Must be actively worked on as someone's top priority right now. rfc-feature RTE (Temp) Denotes an issue related to the Rev the Engine program sig/docs-community Categorizes an issue or PR as relevant to SIG Docs-Community. triage/declined Indicates an issue is not accepted WF6 This is a temporary label that will be removed once data conversion is complete
Projects
None yet
Development

No branches or pull requests

4 participants