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

Add tombstones for removed collections #341

Merged

Conversation

felixfontein
Copy link
Collaborator

Uses the information added in ansible-community/ansible-build-data#459 to add tombstones for removed collections. This ensures that if you are on the collection index page in a previous version of Ansible that still has this collection, and use the version selector to navigate to the current version, that you don't see a 404, but instead see the tombstone page.

This unfortunately only makes the tombstone appear in exactly one major version of Ansible - the version where the collection was removed -, but that's better than nothing IMO :)

@felixfontein felixfontein changed the title [WIP] Add tombstones for removed collections Add tombstones for removed collections Sep 23, 2024
@felixfontein felixfontein marked this pull request as ready for review September 23, 2024 19:32
@felixfontein
Copy link
Collaborator Author

Examples from the Ansible 10 stable docs build:

collections/hpe/index.rst:

.. meta::
  :antsibull-docs: 2.14.0.post0

.. _list_of_collections_hpe:

Collections in the Hpe Namespace
================================

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

There is no collection in this namespace.

.. toctree::
    :maxdepth: 1
    :hidden:

collections/hpe/nimble/index.rst:

:orphan:

.. meta::
  :antsibull-docs: 2.14.0.post0


.. _plugins_in_hpe.nimble:

Hpe.Nimble
==========

This collection has been removed from Ansible 10.

If you want to continue using this collection, you can install it manually using
:code:`ansible-galaxy collection install hpe.nimble`.

@felixfontein
Copy link
Collaborator Author

With ansible-community/antsibull-core#174 and ansible-community/ansible-build-data#465 these tombstones are also shown for collections removed from older Ansible major releases.

@felixfontein felixfontein merged commit 9100c30 into ansible-community:main Oct 8, 2024
13 checks passed
@felixfontein felixfontein deleted the removed-collections branch October 8, 2024 05:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant