ember-learn / guides-source

This repository contains the Ember.js Guides
https://guides.emberjs.com/
MIT License
158 stars 497 forks source link

Naming conventions page #93

Open gabrielgrant opened 6 years ago

gabrielgrant commented 6 years ago

A number of place on the web* link to a "naming conventions" page at https://emberjs.com/guides/concepts/naming-conventions/ however such a page doesn't exist. Searching for a current version of that doc doesn't seem to turn up anything -- the latest version that I've found comes from v1.13: https://guides.emberjs.com/v1.13.0/getting-started/naming-conventions/

Given Ember's emphasis on convention-over-configuration, it would be useful to have a single, canonical reference for these what conventions are (especially when some of them, like :model-name_id-style naming of dynamic segments aren't entirely intuitive).

Was removing this section from the guides an active decision, or just a casualty of all the changes around the 2.0 release that was never rectified? (or was it moved somewhere else and I just haven't found it?)

*: eg https://stackoverflow.com/questions/21027814/why-are-ember-route-parameters-underscore-style and https://github.com/Wikia/guidelines/tree/master/Ember#naming-conventions

migrated from https://github.com/emberjs/website/issues/3422

edit: looks like there was a proposal to remove it in emberjs/guides#91 but there wasn't really a decision other than to deal with it post-2.0

acorncom commented 6 years ago

@gabrielgrant there was a bunch of purging and cleaning that occurred in the 1.13 -> 2.0 timeframe. I would expect it was an active decision, but I wasn't around when that decision was made 😀 Good point on the dynamic segment naming styles.

With that exception do you see much reason for having that entire page? If we don't bring the page back (due to it mainly being redundant info, now that the community uses Ember-CLI across the board), do you have suggestions on what we might want to salvage and where we might want to put things?