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

RFC NEEDED: Documentation deprecation path #49

Open
sptramer opened this issue Aug 1, 2022 · 1 comment
Open

RFC NEEDED: Documentation deprecation path #49

sptramer opened this issue Aug 1, 2022 · 1 comment
Labels
rfc-needed RFCs which have no draft, but are known to be needed

Comments

@sptramer
Copy link
Contributor

sptramer commented Aug 1, 2022

There is an accepted RFC (o3de/sig-release#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.

@sptramer sptramer added rfc-feature Request for Comments for a Feature rfc-needed RFCs which have no draft, but are known to be needed and removed rfc-feature Request for Comments for a Feature labels Aug 1, 2022
@chanmosq
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rfc-needed RFCs which have no draft, but are known to be needed
Projects
Status: Backlog
Development

No branches or pull requests

2 participants