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:
How documentation fits into the deprecation process, including when engineers tell us deprecation is starting
What documentation should exist around deprecation
Unified messaging strategy for deprecated content items
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.
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:
Note what version the feature became deprecated in. When we have versioned docs, the versions that still have the feature should still have docs for that feature.
Making sure that part of the o3de code triage process involves sig-docs-community for deprecation PRs.
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.