search

OpusVL / perldoc.perl.org

perldoc.perl.org website
27 stars 10 forks source link

Perldoc is broken! #36

Open ANSI-C opened 5 years ago

ANSI-C commented 5 years ago

Search feature is gone, links do not work, the new interface is space wasting and badly formatted, can we have back the good old site? The new one is just, sorry to be rude, horrible and unusable.

JohnMica commented 5 years ago

@ANSI-C

without you being specific in your 'issue descriptions' it is not extremely useful to the iterative process of improving the new site.

ANSI-C commented 5 years ago

@ANSI-C

* search (coming in the next iteration)

* links dont work - care to elaborate what links are you talking about ? what pages are the ones causing this links not to work (besides the ones already presented in other issues #35 , #28 ) ?

* badly formatted = care to elaborate what you actually mean by this ?

without you being specific in your 'issue descriptions' it is not extremely useful to the iterative process of improving the new site.

sorry for being too coincided, but was shocked by realizing that perldoc has been completely changed without testing it properly beforehand and (AFAIK) without user feedback on new design. About bugs:

bbrtj commented 5 years ago

I agree with ANSI-C on his criticism. I feel like browsing some bootstrap-based front page of programming language and not a technical documentation. The fonts seem too big, there's a lot of pixels wasted for either blank space (left, right margin, top bar) or things that tell you nothing about what you're looking for (Perl 5 version 30.0 documentation being h1...). When you add current lack of searching on the page it becomes very hard to have good impressions of the current layout. Even the beta version info seems too big. I just feel like most of my screen is now pure visual noise. I don't want it to be pretty, I want it readable, but right now it's just not, not for me at least. Screenshot from 2019-06-17 23-15-16 Look at this as an example.

bbrtj commented 5 years ago

To add some positive input I've made quick-and-dirty console editing to make it look more pleasing to my own eye. Of course I didn't change everything listed above, but this is what I ended up with Screenshot from 2019-06-18 00-00-57 It's much quicker to find what I'm looking for here, and it wasn't much work. Also the entropy is exactly the same (no information was added or removed, only moved around)

hakonhagland commented 5 years ago

Thanks for working on the new site. But I have to agree with @ANSI-C that there should be a way to access (a link ?) the old site (that was working perfectly in my browser) while bugs for the new site are being fixed. Since I cannot scroll on the new site (see issue #16) I cannot use it. Also, when I google for a topic on perldoc.perl.org only the new page comes up and it is frustrating. Why not test out the beta version on a different URL until most bugs were fixed before releasing it?

ANSI-C commented 5 years ago

And last but not least, I would like to have good old sidebar back, with quick links to core modules list, functions, and so on. We have one third of page width just blank, you have all the space needed to add back the sidebar, even with responsive layout if you like.

ANSI-C commented 5 years ago

For anyone interested you can download the last copy of old site for Perl 5.22 for offline view HERE Unfortunately tarballs for 5.24, and 5.26 are not available. The great thing: the very clever Javascript search engine of old site works even offline on your disk. Kudos to creator(s)!

randalmacdonald commented 5 years ago

As a long time Perl developer, I appreciate the effort to bring the language's web-based documentation up to date. However, not providing search functionality in this beta version we're all now apparently forced to use is unacceptable. Lack of site search has made my Perl programming work much more cumbersome and time-consuming. When will search become available?

(Thanks to ANSI-C for recommending the temporary work-around of downloading the Perl 5.22 tarball, which I've done and which allows me to search that version's documentation. Kudos indeed to the creator(s) of that site's Javascript search engine!)

I agree with the other comments posted here by ANSI-C, brtastic and hakonhagland. I particularly want to echo what hakonhagland asked: "Why not test out the beta version on a different URL until most bugs were fixed before releasing it?"

Grinnz commented 5 years ago

As mentioned elsewhere, for those who need it in the meantime, the stable alternative https://perldoc.pl has a search feature.

ANSI-C commented 5 years ago

As mentioned elsewhere, for those who need it in the meantime, the stable alternative https://perldoc.pl has a search feature.

your site is also very useful, thanks!

nuclight commented 5 years ago

https://perldoc.pl is banned in some countries, at least Russia (governments are blocking entire segments in war with e.g. Telegram, many innocent sites are also affected).

ANSI-C commented 5 years ago

https://perldoc.pl is banned in some countries, at least Russia (governments are blocking entire segments in war with e.g. Telegram, many innocent sites are also affected).

Then the best option is to download tarball of old site and use it offline, I am already doing that, and it works even better than old online site: http://web.archive.org/web/20170709212848/http://perldoc.perl.org/perldoc-html.tar.gz

harmic commented 5 years ago

Another option for those that find the new perldoc unusable: https://devdocs.io/

That site supports perl fairly well, supports offline usage, and has good search capabilities.

jaypittman commented 4 years ago

Looking here: https://perldoc.perl.org/5.30.0/index-functions-by-cat.html#Numeric-functions This defines exp() as: raise I to a power Raise what? Is this a one? Or an ell? Did someone mean e?

Grinnz commented 4 years ago

Yes, that is a misrendering of an italicized e. You can see the same issue in the description of __SUB__.