hapipal / boilerplate

A friendly, proven starting place for your next hapi plugin or deployment
https://hapipal.com
183 stars 27 forks source link

Retire "Custom Swagger" and "(Non-fancy) Templated Site" flavors #95

Closed devinivy closed 3 years ago

devinivy commented 4 years ago

I intend to retire two of the flavors: Custom Swagger and Template Site. Note that these both have alternate, similar flavors which will not be retired: Swagger and Fancy Templated Site.

The custom swagger flavor is hard to keep up to date (duplicates templates from hapi-swagger's codebase), provides similar functionality to the non-custom flavor, and I haven't seen it receive a ton of usage. In the distant past the swagger UI had some quirks and we pretty much always needed to customize it to work around those, but that doesn't seem to be the case today. It isn't hard to get the custom templates going once you have hapi-swagger setup, so perhaps we can provide some brief instructions for users who want the customization.

The templated site flavor is simply too similar to it's "fancy" counterpart which provides additional often-desired functionality (e.g. ability to write modern frontend javascript, browsersync, a CSS pre-processor). There is already a build step for the production frontend in the non-fancy version, so there's really not a whole lot more overhead to provide pre-processing steps for JS and CSS assets— plus the build steps have remained really reliable over time. The hapipal.com codebase is also predicated on the fancy version of this flavor.

And that's pretty much it! I think retiring these flavors will streamline boilerplate maintenance and make time to work on other things which provide more 💞 amongst the community. As always, this decision is open for feedback. It wont come into play until v3 of the boilerplate is released, which wont be something that happens immediately.