pages-gem icon indicating copy to clipboard operation
pages-gem copied to clipboard

Proposal: replace jekyll-paginate with octopress-paginate

Open Pym opened this issue 8 years ago • 17 comments

Hello there!

jekyll-paginate by @parkr is no longer under active development:

Feel free to build it, test it, and share widely. I worked on an idea in #22 but I just can't get excited about pagination. My vote is to kill off this version and move in a new vision that is as easy as possible to use, but still flexible. – @parkr

And that's exactly what @imathis developed: octopress-paginate

It's backward compatible plugin with jekyll-paginate but offers more possibilities, like the ability to paginate collections :)

Pym avatar Mar 19 '16 01:03 Pym

@Pym it also tests on an outdated version of Jekyll and Ruby, neither of which Jekyll currently supports.

envygeeks avatar Apr 13 '16 20:04 envygeeks

Is it still open? I would like to work on this..

shlok007 avatar Jul 04 '16 08:07 shlok007

Any news on this?

rogervila avatar Mar 16 '17 20:03 rogervila

AFAIC https://github.com/sverrirs/jekyll-paginate-v2 works fine and can be used with GitHub Pages as long as you build your site via Travis CI.

DirtyF avatar Mar 16 '17 23:03 DirtyF

Are there any obstacles to push it further? Paginate collections is only the one thing that is missed for me currently on GitHub pages.

r4fx avatar Apr 22 '17 18:04 r4fx

When you make a big change to a default like this across millions of sites, you have the potential to introduce friction (and thus frustration). Put another way "this is newer" is not a good enough reason to make a potentially breaking change. What's the advantage of Octopress paginate? What's wrong with the existing pagination solution? Are there existing bugs going unfixed? Is the octopress implementation 100% backwards compatible?

benbalter avatar Apr 24 '17 14:04 benbalter

Jekyll paginate only paginates posts whereas Octopress paginates collections. That's the biggest benefit I think.

BinaryMoon avatar Apr 29 '17 15:04 BinaryMoon

I understand that replace plugins may brings frictions, so plaese don't replace but add to white list as new alternative, this will be safe for all.

r4fx avatar Apr 29 '17 21:04 r4fx

add to white list as new alternative, this will be safe for all.

Adding more choices aren't always the right option. In the short term, you're adding cognitive burden as users need to evaluate which pagination library's best, weigh the relative tradeoffs, etc. In the long term, plugins have a non-zero maintenance cost in terms of security, documentation, support, and backwards compatibility.

AFAIC https://github.com/sverrirs/jekyll-paginate-v2 works fine and can be used with GitHub Pages as long as you build your site via Travis CI.

The readme notes that it's lacking some critical tests. If that plugin were to become a mature, drop-in replacement for jekyll-paginate, I'd prefer to go that route considering it's intended to be a continuation of the original functionality, not an alternative replacement.

benbalter avatar Jun 13 '17 13:06 benbalter

Hi, What is the status of this issue? Can we use jekyll-paginate-v2 for github pages? I was able to use it in local. But it did n't work when committed. I was not able to configure jekyll-paginate, which used to work earlier.

niyasc avatar Nov 28 '17 19:11 niyasc

/cc @sverrirs

DirtyF avatar Nov 28 '17 20:11 DirtyF

Hi all, and thanks for the mention, I'm the author of the jekyll-paginate-v2 plugin :)

The readme notes that it's lacking some critical tests. If that plugin were to become a mature, drop-in replacement for jekyll-paginate, I'd prefer to go that route considering it's intended to be a continuation of the original functionality, not an alternative replacement.

You´re absolutely correct @benbalter and honestly this sounds like the perfect motivation for me and some energetic co-programmers to beef up the coverage for this plugin.

As to the current state, the jekyll-paginate-v2 plugin is in a relatively feature stable state. There are 6 open issues, only one which is a bug (actually a regression related to the lazy member initialization discussed in another ticket in the jekyll project).

However, the major weakness of the jekyll-paginate-v2 project currently is that it only really has me as a contributor. I would be more than happy to add more people to the team and delegate maintenance and feature additions to ensure that it doesn't stagnate.

sverrirs avatar Nov 28 '17 20:11 sverrirs

I would gladly support a move to replace jekyll-paginate with jekyll-paginate-v2. One way of reducing the bus factor is to migrate the project to the jekyll org, if you're up for that. Happy to have a discussion with you in an issue on jekyll-paginate-v2 about moving forward and shipping this plugin as a replacement to today's jekyll-paginate.

parkr avatar Nov 28 '17 21:11 parkr

the bus factor

lol, deliciously dark ;)

sverrirs avatar Nov 28 '17 22:11 sverrirs

I would gladly support a move to replace jekyll-paginate with jekyll-paginate-v2. One way of reducing the bus factor is to migrate the project to the jekyll org, if you're up for that. Happy to have a discussion with you in an issue on jekyll-paginate-v2 about moving forward and shipping this plugin as a replacement to today's jekyll-paginate.

+1

rogervila avatar Apr 05 '19 11:04 rogervila

Can we close this as a won't fix, it does not look like GitHub Pages is going to accept more plugins. Just use another hosting solution like Netlify that accept any Jekyll plugins.

DirtyF avatar Apr 05 '19 11:04 DirtyF

Has this issue ever been revisited? It seems all the more relevant now, as jekyll-paginate is no longer under active development.

andrew-paterson avatar Jul 27 '20 14:07 andrew-paterson