search

ansible-community / antsibull-docs

Tooling for building Ansible documentation
https://ansible.readthedocs.io/projects/antsibull-docs/
GNU General Public License v3.0
29 stars 17 forks source link

Show deprecated collection status #330

Closed felixfontein closed 2 months ago

felixfontein commented 2 months ago

Fixes #93.

felixfontein commented 2 months ago

We should also get rid of the v1 usage, but that will be a larger effort, especially for the docs schemas and the linting. I think we need a generic solution for https://github.com/ansible-community/antsibull-core/blob/7a6d701a6070f13496fe68f23514784532c2938a/src/antsibull_core/collection_meta.py#L143-L151; we really don't want to keep track of such a list of classes (and in particular its order) manually for the docs schemas.

But that's something for follow-up PRs, for now let's stick to removing the v1 support of the compatibility layer.

felixfontein commented 2 months ago

I generated the stable docs RST files for 10.4.0, here are some excerpts:

List of all collections (collections/index.rst):

Collection Index
================

These are the collections with docs hosted on `docs.ansible.com <https://docs.ansible.com/>`_.

* :ref:`amazon.aws <plugins_in_amazon.aws>`
...
* :ref:`fortinet.fortios <plugins_in_fortinet.fortios>`
* :ref:`frr.frr <plugins_in_frr.frr>` :ansdeprecatedmarker:`{"version": 11}`
* :ref:`google.cloud <plugins_in_google.cloud>`
...
* :ref:`ibm.qradar <plugins_in_ibm.qradar>`
* :ref:`ibm.spectrum_virtualize <plugins_in_ibm.spectrum_virtualize>` :ansdeprecatedmarker:`{"version": null}`
* :ref:`ibm.storage_virtualize <plugins_in_ibm.storage_virtualize>`
...
* :ref:`inspur.ispim <plugins_in_inspur.ispim>`
* :ref:`inspur.sm <plugins_in_inspur.sm>` :ansdeprecatedmarker:`{"version": 11}`
* :ref:`junipernetworks.junos <plugins_in_junipernetworks.junos>`
...

Deprecation notes for collections:

Frr.Frr
=======

Collection version 2.0.2

.. note::
    The frr.frr collection has been deprecated and will be removed from Ansible 11.
    See the \ `discussion thread <https://forum.ansible.com/t/6243>`__ for more information.

Ibm.Spectrum_Virtualize
=======================

Collection version 2.0.0

.. note::
    The ibm.spectrum\_virtualize collection has been renamed to :ref:`ibm.storage\_virtualize <plugins_in_ibm.storage_virtualize>` and will eventually be removed from Ansible.
    If you use content from ibm.spectrum\_virtualize, please update FQCNs in your playbooks and roles!
    When creating new playbooks or roles, directly use content from ibm.storage\_virtualize instead.

Inspur.Sm
=========

Collection version 2.3.0

.. note::
    The inspur.sm collection is considered unmaintained and will be removed from Ansible 11.
    See the \ `discussion thread <https://forum.ansible.com/t/2854>`__ for more information.

Netapp.Storagegrid
==================

Collection version 21.12.0

.. note::
    The netapp.storagegrid collection is considered unmaintained and will be removed from Ansible 11.
    See the \ `discussion thread <https://forum.ansible.com/t/2811>`__ for more information.

Openvswitch.Openvswitch
=======================

Collection version 2.1.1

.. note::
    The openvswitch.openvswitch collection has been deprecated and will be removed from Ansible 11.
    See the \ `discussion thread <https://forum.ansible.com/t/6245>`__ for more information.
felixfontein commented 2 months ago

@samccann @oraNod thanks for your contribution!