Deprecate this module (Ansible Collection Metal)

[displague]

SUMMARY

This project should be deprecated in favor of https://github.com/equinix-labs/ansible-collection-equinix which has near parity with this provider and will be gaining additional capabilities over time.

Parity is being tracked in https://github.com/equinix-labs/ansible-collection-equinix/milestone/2

https://community.equinix.com/t5/Announcements/Ansible-Collection-Equinix-v0-1-0-Release/ba-p/1343

The README.md should be updated and any Ansible collection practices around deprecation should be applied. https://ansible.readthedocs.io/projects/galaxy-ng/en/latest/usage_guide/collections/?h=deprecate#deleting-and-deprecating-collections

• Deprecate: https://galaxy.ansible.com/ui/repo/published/equinix/metal/
• Include a notice that this repo is deprecated
• Update the project URL (GH Settings) to point to the new project
• Create a migration guide in the new project (https://github.com/equinix-labs/ansible-collection-equinix/blob/main/MIGRATION.md)

Possibly related: #24

ISSUE TYPE

• Documentation Report

COMPONENT NAME

ANSIBLE VERSION

[displague]

Before closing this issue, a migration guide should exist and be included in the new project.

• Docs: Provide a migration guide on how to convert from the Packet and Metal providers ansible-collection-equinix#122

[displague]

All steps for this deprecation have been completed

[displague]

The Ansible Inclusion discussion referenced this issue (ansible-collections/ansible-inclusion#15)

There may be more to do in "deprecating" this module in order to refer old modules to the new Equinix modules.

https://docs.ansible.com/ansible/devel/dev_guide/developing_collections_migrating.html