Fork me on GitHub
Subscribe 3

Ticket #86 (fixed bug)

Remove example plugin from distribution

  • Created: 2010-07-31 19:01:37
  • Reported by: Pierre
  • Assigned to: Reines
  • Milestone: 1.4.3
  • Component: plugins
  • Priority: lowest

Currently FluxBB is shipped with an example plugin which is also active.

While this might be easily removed by the user it would be better to just move it into the wiki or create a docs subdir for such documentation.

For easier maintenance I prefer not touch the upstream code whenever possible.

History

ridgerunner 2010-08-03 00:51:23

I disagree. The example plugin is small, completely benign, and very well documented. Being pre-installed, it intrinsically provides very useful information on where and how plugins are correctly implemented. If it is removed then the new user will be forced to look elsewhere for instructions on how (and where) to properly install a plugin (and may not even know that an execellent example even exists).

From a cost-benefit point of view, I say, "Keep it in!"

Pierre 2010-08-03 07:48:14

Sure, it could also be kept but disabled. Like moving it to a docs subdir (might be interesting for other documentation in future) or rename it to AMP_Example.php.dist

Franz 2010-08-17 15:35:32

Well, we have a mod development kit, so in a way I guess it would make sense to just put that file in the wiki, too.

Obviously the example plugin is only interesting for developers (not every site admin cares), but I'd be just fine keeping it, too.

Reines 2010-08-18 14:08:46

  • Milestone set to 1.4.3.
  • Owner set to Reines.
  • Status changed from open to fixed.

I've removed it from the distribution and added it to the wiki.