Document/standardize using plugins as gems or .rb files #1417

Closed
robwierzbowski opened this Issue Aug 13, 2013 · 7 comments

Comments

Projects
None yet
5 participants
@robwierzbowski
Contributor

robwierzbowski commented Aug 13, 2013

Some of the plugins I use are the documented .rb files (drop them into your plugin folder), while others are gems that require a more complicated setup procedure.

I think it would be worth documenting setup for both, and possibly the benefits of either approach. Is there an official preference on plugins as gems or .rb files?

@mattr-

This comment has been minimized.

Show comment
Hide comment
@mattr-

mattr- Aug 14, 2013

Member

There's not an existing standard. It's really up to how the plugin developer decides to package it.

Member

mattr- commented Aug 14, 2013

There's not an existing standard. It's really up to how the plugin developer decides to package it.

@robwierzbowski

This comment has been minimized.

Show comment
Hide comment
@robwierzbowski

robwierzbowski Aug 14, 2013

Contributor

Thanks @mattr-. I'll give a shot at adding a brief gem section to the plugins page when I get some spare time.

Contributor

robwierzbowski commented Aug 14, 2013

Thanks @mattr-. I'll give a shot at adding a brief gem section to the plugins page when I get some spare time.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Sep 15, 2013

Member

What do you think about adding a field in _config.yml (array) that would contain a list of gem names to be required on start-up? Obviously only in unsafe mode.

Member

parkr commented Sep 15, 2013

What do you think about adding a field in _config.yml (array) that would contain a list of gem names to be required on start-up? Obviously only in unsafe mode.

@robwierzbowski

This comment has been minimized.

Show comment
Hide comment
@robwierzbowski

robwierzbowski Sep 15, 2013

Contributor

That's a great idea. Dropping plugins into the plugin folder encourages inlining dependencies, but is easy to use; the "_plugins/ext.rb" pattern is confusing to me, and only gets worse when you mix and match. Something like

  1. Add gems to your gemfile
  2. Install gems
  3. Require gems in _config.yml

is way better, and easy enough that it could be the default recommendation.

I like that this would let you switch which gems you're requiring by switching/cascading config files.

Contributor

robwierzbowski commented Sep 15, 2013

That's a great idea. Dropping plugins into the plugin folder encourages inlining dependencies, but is easy to use; the "_plugins/ext.rb" pattern is confusing to me, and only gets worse when you mix and match. Something like

  1. Add gems to your gemfile
  2. Install gems
  3. Require gems in _config.yml

is way better, and easy enough that it could be the default recommendation.

I like that this would let you switch which gems you're requiring by switching/cascading config files.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Sep 15, 2013

Member

That is a great workflow! We have to support both at least for a while but this would be a cool feature for 1.3. @mattr- @benbalter let me know if you think that'd be a good idea.

Member

parkr commented Sep 15, 2013

That is a great workflow! We have to support both at least for a while but this would be a cool feature for 1.3. @mattr- @benbalter let me know if you think that'd be a good idea.

@benbalter

This comment has been minimized.

Show comment
Hide comment
@benbalter

benbalter Sep 16, 2013

Contributor

👍 (sans safe mode)

Contributor

benbalter commented Sep 16, 2013

👍 (sans safe mode)

@parkr parkr referenced this issue Sep 16, 2013

Merged

Add `gems` for better plugin management #1557

2 of 3 tasks complete
@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Jul 31, 2014

Member

We now have gemified plugins! If you have time to write a quick tutorial (or screencast!), we'd be happy to publish it.

Member

parkr commented Jul 31, 2014

We now have gemified plugins! If you have time to write a quick tutorial (or screencast!), we'd be happy to publish it.

@parkr parkr closed this Jul 31, 2014

@jekyllbot jekyllbot locked and limited conversation to collaborators Feb 27, 2017

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.