Coder Social home page Coder Social logo

Comments (2)

chanmosq avatar chanmosq commented on August 29, 2024

We discussed this at sig-docs-community meeting on 11/08/2022.

We are in agreement on the following things in regards to docs for Gems that are not part of the O3DE distribution:

  • Documentation for Gems and other O3DE objects that are not part of the O3DE repositories are not to be maintained in O3DE Docs. Because the state of that Gem is not maintained in O3DE's source code, it's documentation also is out-of-scope for O3DE Docs. Out of scope are Gem reference documentation, tutorials, samples, and any other documentation on the o3de.org website outside of blog posts.
  • Although we do not maintain such docs, we can maintain a page in the O3DE Docs that links to docs for non-included Gems and objects. Linked docs should be complete and trustworthy sources. (E.g. Docs written by an O3DF partner who's created a Gem and maintains the docs in their website.)

There are still some open questions:

  • What about docs for a non-included Gem that was written by a contributor, not the owner of the feature themselves?

    Such docs are highly appreciated contributions, but due to ambiguity on ownership of maintenance of those docs, we request that they are not part of the official O3DE Docs. Instead, such docs may be a good candidate for a blog post. The contributor would be advised to speak with the community side of sig-docs-community to verify if blogs is an appropriate place for their doc and make this arrangement.
    Example case: A document about an artist workflow for creating 3D assets for O3DE in Blender. This document is highly dependent on the state of Blender, which is out of our control and should be kept out of O3DE Docs. However, this may be a good candidate for a blog post.
    Note: This question is still open because it's not an established practice and depends on O3DE community's thoughts.

  • What do we do with docs about non-included Gems that are already in O3DE Docs?

    We don't have an answer for this at this time. This may require a larger discussion with the O3DF, perhaps through TSC. Docs that fall under this category include the Kythera AI tutorial.

from sig-docs-community.

chanmosq avatar chanmosq commented on August 29, 2024

See notes from meeting: #84 (comment)

from sig-docs-community.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.