# How-to deprecate X - Documentation to be added, but where?

**URL:** <https://forum.ansible.com/t/how-to-deprecate-x-documentation-to-be-added-but-where/39458>\
**Category:** Get Help\
**Tags:** documentation, collections, dawgs-meeting\
**Created:** [January 5, 2025, 12:07am UTC](https://forum.ansible.com/t/how-to-deprecate-x-documentation-to-be-added-but-where/39458 "2025-01-05T00:07:28Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![russoz](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/russoz/32/127_2.png) [@russoz](https://forum.ansible.com/u/russoz)\
**Post date:** [January 5, 2025, 12:07am UTC](https://forum.ansible.com/t/how-to-deprecate-x-documentation-to-be-added-but-where/39458/1 "2025-01-05T00:07:28Z")

</div>

Hi everyone,

Being a maintainer for community.general for a while means I have had to deal with a number of different situations. It is a lot of different things we need to remember and, honestly, I cannot keep all of them in mind. One of those things is deprecating stuff, and then all the different ways to deprecate stuff, depending on what _stuff_ is. So, I wrote this document to be my cheatsheet:

> <https://github.com/russoz-ansible/ansible-contrib-unofficial/blob/main/deprecations.md>

Recently, a [question came up](https://github.com/ansible-collections/community.general/issues/9055#issuecomment-2514800530) in one of the collection’s issues on how to deprecate the current default value of a parameter, which is one of the cases covered in the deprecations doc, so I posted the link there and it was suggested (by @felixfontein) that it could be added to the main Ansible docs. Great idea!

@samccann suggested that it could be added to the end of [https://docs.ansible.com/ansible/latest/dev\_guide/module\_lifecycle.html](https://docs.ansible.com/ansible/latest/dev_guide/module_lifecycle.html) , however as I was starting to actually get it done, I gave it a second look and it does not look like the deprecations document has much to do with _module_ lifecycle.

I am raising this topic to bring in suggestions and/or other perspectives on the issue. Where should that piece of documentation go?

---

<div class="post-metadata">

**Author:** ![samccann](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/samccann/32/18_2.png) [@samccann](https://forum.ansible.com/u/samccann)\
**Post date:** [January 14, 2025, 5:10pm UTC](https://forum.ansible.com/t/how-to-deprecate-x-documentation-to-be-added-but-where/39458/2 "2025-01-14T17:10:48Z")

</div>

@russoz We chatted about this in the DaWGs meeting the the recommendation is for you to add a new page to the developer guide for this. Thanks!