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 deprecation marker to deprecated modules/plugins in indexes and plugin/module lists #141

Open
felixfontein opened this issue May 3, 2023 · 5 comments

Comments

@felixfontein
Copy link
Collaborator

No description provided.

@felixfontein felixfontein transferred this issue from ansible-community/antsibull-core May 3, 2023
@felixfontein
Copy link
Collaborator Author

And/or have a separate page listing everything that is deprecated.

@felixfontein
Copy link
Collaborator Author

Where should the "deprecated content" list(s) live? Should there be one per collection, or even per plugin type per collection? Should there be a global "deprecated" list (for all collections)? Or one for every plugin type, but then for all collections?

@oraNod
Copy link
Contributor

oraNod commented Aug 26, 2024

I feel like a global "deprecated" list might be easier for community to find things and avoids fragmentation. Not sure though. This sounds like a good one for the next SC WG.

@samccann
Copy link
Contributor

samccann commented Sep 6, 2024

Coming in late here - So back in the dim dawn of time, our 'all modules' pages (2.9 and earlier) used to mark each module with a (D) that was deprecated. We could consider doing that again (but with more dramatic deprecation marker. )

Or... we could ask on the forum! :-)
I think the options are:

  1. Add a deprecation marker within our collection/module indices pages
  2. Create a "Deprecated plugins' page/list for all of them across all collections

I think we we do add markers to our index pages, it should be for all of them (main indices and per-collectoin index pages).

@felixfontein
Copy link
Collaborator Author

@samccann 1. is already implemented by #320, see for example https://ansible.fontein.de/collections/index_module.html#community-docker (the removal versions won't be shown on docs.ansible.com to avoid confusion of Ansible versions with collection versions)

About 2.: either that, or having a list (one list per collection!) of deprecated plugins. Or split the list by plugin type (one file per plugin type). But yeah, a forum discussion sounds like a good idea. (For simplicity I'm currently tending to one page for all plugin types of all collections.)

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

No branches or pull requests

3 participants