metacpan-web icon indicating copy to clipboard operation
metacpan-web copied to clipboard

"Install Instructions" in sidebar should/could include/reference INSTALL(.*?) where present

Open kentfredric opened this issue 8 years ago • 6 comments

The most embarrassing example is this:

https://metacpan.org/release/perl

Where the "Install Instructions" say

cpanm utf8

uh.

Given https://metacpan.org/source/SHAY/perl-5.22.1/INSTALL exists, it would be a better destination. Especially how hard it is to find that file.

Additionally, you presently can't view that file as POD, only source, because the module documentation link on that page links to something entirely useless:

https://metacpan.org/pod/INSTALL

Which is apparently part of Wordnet-Similarity.

All sorts of horror :(

kentfredric avatar Dec 20 '15 15:12 kentfredric

Also, it appears that the code in the template for this feature currently uses the last item in the sorted module list of a given release to give the install instructions even when on a release page.

Perhaps on a release page, the release.main_module should have a higher priority than the others?

zmughal avatar Dec 22 '15 16:12 zmughal

As per #1641 - We should be using main_module from the release here.

ranguard avatar Mar 04 '16 22:03 ranguard

Just adding another case: https://metacpan.org/pod/GD needs more than just cpanm GD. It would be nice if there was a clear link to the INSTALL file or the README file.

szabgab avatar Oct 15 '20 04:10 szabgab

I know we can already do this, but this would be easier if the API designated where the INSTALL and README files are located in the release object.

oalders avatar Oct 15 '20 20:10 oalders

Is this therefore a feature request for metacpan-api?

mohawk2 avatar Oct 16 '20 13:10 mohawk2

The release/interesting_files or release/files_by_category end points can provide this information.

haarg avatar Oct 16 '20 14:10 haarg