Skip to content
This repository has been archived by the owner on May 14, 2024. It is now read-only.

[Vote ended on 2022-02-01] Mention plugin type more prominently #61

Closed
felixfontein opened this issue Jan 11, 2022 · 15 comments
Closed

Comments

@felixfontein
Copy link
Contributor

Summary

As a result of the feedback collected in #57 I've adjusted ansible-community/antsibull#364 to mention the plugin time more explicitly in some less places than originally planned:

  1. Mention the plugin type in the page main titles. This also mentions it in the HTML title, and makes both on-site and external search results much better. (See for example There are two different documentation pages for "ansible.builtin.file"? ansible/ansible#75652)
  2. Mention the plugin type in every collection's plugin index. This makes it possible to search for file m (or type some more letters of module) to find the documentation of the file module, and file l for the lookup on the ansible.builtin plugin index (https://ansible.fontein.de/collections/ansible/builtin/#plugin-index).

(There are two more changes: in the stub page for deprecated redirects, and in the boilerplate for collection plugins and modules, which always said 'plugin' without being more specific. I think these are not controversial at all.)

These changes improve actual usage problems (using the site search, and searching a collection's plugin index).

If you are in favor of merging this, and making the plugin type more prominent, please add a +1 vote to this issue. If you prefer not to have this PR in this form, please add a -1 vote. Please use comments and not emoticon reactions. Thanks.

I've set the 1st of February as a deadline, so we have three weeks to complete this vote.

@briantist
Copy link

+1

3 similar comments
@tadeboro
Copy link

+1

@Andersson007
Copy link
Contributor

Andersson007 commented Jan 12, 2022

+1

@jillr
Copy link

jillr commented Jan 12, 2022

+1

@felixfontein
Copy link
Contributor Author

+1 (might have been obvious, but for sake of simplicity of counting votes afterwards let's make this explicit :) )

@gundalow
Copy link
Contributor

+1
This is much clearer, thank you.

@cybette
Copy link
Member

cybette commented Jan 13, 2022

+1 (I like the clarity it provides)

@gundalow gundalow changed the title [Vote ends on 2022/02/01] Mention plugin type more prominently [Vote ends on 2022-02-01] Mention plugin type more prominently Jan 13, 2022
@samccann
Copy link

+1

1 similar comment
@jamescassell
Copy link

+1

@markuman
Copy link
Contributor

+1

1 similar comment
@acozine
Copy link
Contributor

acozine commented Jan 27, 2022

+1

@felixfontein
Copy link
Contributor Author

I've counted votes: 8 steering committee members votes +1, three community members voted +1, and there was no other vote. Would be glad if someone could confirm this.

@tadeboro
Copy link

tadeboro commented Feb 1, 2022

My counts:

+1: briantist (SC), tadeboro (SC), Andresson007 (SC), jillr (SC), felixfontein (SC), gundalow (SC), cybette, samccann, jamescassell (SC), markuman, acozine (SC)
-1:

Summary: +8 by steering committee members, +3 from community members.

@felixfontein felixfontein changed the title [Vote ends on 2022-02-01] Mention plugin type more prominently [Vote ended on 2022-02-01] Mention plugin type more prominently Feb 1, 2022
@felixfontein
Copy link
Contributor Author

Thanks everyone for taking part in this! I'll merge ansible-community/antsibull#364, create a new antsibull release, and update ansible/ansible#76759 to get this included in the devel docs ASAP!

@felixfontein felixfontein added being_implemented This is currently being implemented and removed active-vote These are currently active votes labels Feb 1, 2022
@felixfontein
Copy link
Contributor Author

Since this is already included in the devel docs, closing. Thanks everyone!

@Andersson007 Andersson007 added implemented and removed being_implemented This is currently being implemented labels Feb 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests