search

aws / aws-tools-for-powershell

The AWS Tools for PowerShell lets developers and administrators manage their AWS services from the PowerShell scripting environment.
Apache License 2.0
238 stars 79 forks source link

Additional tags for AWS.Tools.* modules #34

Closed scrthq closed 4 years ago

scrthq commented 5 years ago

First, AWESOME work on modularizing the AWSPowerShell module!!! Going through PowerShell Gallery, I actually found it a bit difficult to not immediately find what I was after as all of the AWS.Tools modules are returned in search results, even when scoping to a specific service like AWS.Tools.EC2 and sorting by relevance. I knew what I was looking for, but the EC2 module was still buried on Page 5 even though it was an exact name match.

My suggestions to improve discoverability, both of the modules themselves as well as supported platforms, would be to add the following tags to each module:

You can see here that searching returns 0 results when specifying the Operating System you're looking for compatible modules for (all checked to demo that this still doesn't return anything because of the missing tags):

image

Also - if these are intended to be treated as prerelease, can they be versioned as prerelease versions so that they aren't discovered by someone searching for non-prerelease versioned moduled matching, say, AWS*?

matteo-prosperi commented 5 years ago

Hello, thank you for your suggestion. I will look into adding more tags.

I think that the reason for the many results on the Gallery when searching for AWS.Tools.EC2 or AWS.Tools.S3 is that we use the names of these two modules in the description of every other AWSPowerShell and AWS.Tools module. If you search for AWS.Tools.EKS, for example, only that module is listed. While this is not ideal, we want the description to help customers orient themselves between the many AWSPowerShell and AWS.Tools modules now available in the gallery. I suppose the first result is AWSPowerShell because has many more historical downloads than the new module with the exact name match. If this will end up being confusing for customers, I will remove the AWS.Tools.EC2 and AWS.Tools.S3 text from the other modules description, this should solve the problem.

About marking the modules as prerelease, I tried that but PowerShell Gallery doesn't support modules which depends on other prerelease modules. I reported the issue to Microsoft here.

scrthq commented 5 years ago

Got it! Thanks for the feedback, @matteo-prosperi !! I may have hit a fluke search and will check the descriptions to see if including those there makes sense, but I'm anticipating that it does. I appreciate the response!

matteo-prosperi commented 4 years ago

We have added the missing tags in the latest release of AWS.Tools.* modules. Thanks for opening this issue.