o3de / sig-docs-community

Resources for the Open 3D Engine Documentation & Community Special Interest Group (SIG)
Apache License 2.0
8 stars 9 forks source link

RFC NEEDED: Documentation deprecation path #49

Open sptramer opened 2 years ago

sptramer commented 2 years ago

There is an accepted RFC (https://github.com/o3de/sig-release/issues/50) for a deprecation path for code in O3DE. As raised on the RFC, docs is downstream of the deprecation process and needs to have our own policies and practices put in place to handle deprecation.

This RFC should address:

Undoubtedly there is more to consider! Please leave a comment or begin a pre-RFC discussion on the forums if you're interested in helping with this process.

chanmosq commented 2 years ago

For communicating deprecated features in documentation, the solution may just be having a "deprecation" shortcode. Some things to keep in mind with the docs deprecation process: