{"action":"created","issue":{"url":"https://api.github.com/repos/ember-learn/ember-cli-addon-docs/issues/166","repository_url":"https://api.github.com/repos/ember-learn/ember-cli-addon-docs","labels_url":"https://api.github.com/repos/ember-learn/ember-cli-addon-docs/issues/166/labels{/name}","comments_url":"https://api.github.com/repos/ember-learn/ember-cli-addon-docs/issues/166/comments","events_url":"https://api.github.com/repos/ember-learn/ember-cli-addon-docs/issues/166/events","html_url":"https://github.com/ember-learn/ember-cli-addon-docs/pull/166","id":319054793,"number":166,"title":"[refactor] Simplify and generalize Module links","user":{"login":"pzuraq","id":685518,"avatar_url":"https://avatars3.githubusercontent.com/u/685518?v=4","gravatar_id":"","url":"https://api.github.com/users/pzuraq","html_url":"https://github.com/pzuraq","followers_url":"https://api.github.com/users/pzuraq/followers","following_url":"https://api.github.com/users/pzuraq/following{/other_user}","gists_url":"https://api.github.com/users/pzuraq/gists{/gist_id}","starred_url":"https://api.github.com/users/pzuraq/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pzuraq/subscriptions","organizations_url":"https://api.github.com/users/pzuraq/orgs","repos_url":"https://api.github.com/users/pzuraq/repos","events_url":"https://api.github.com/users/pzuraq/events{/privacy}","received_events_url":"https://api.github.com/users/pzuraq/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-04-30T22:17:04Z","updated_at":"2018-05-01T17:55:10Z","closed_at":"2018-05-01T17:55:05Z","author_association":"CONTRIBUTOR","pull_request":{"url":"https://api.github.com/repos/ember-learn/ember-cli-addon-docs/pulls/166","html_url":"https://github.com/ember-learn/ember-cli-addon-docs/pull/166","diff_url":"https://github.com/ember-learn/ember-cli-addon-docs/pull/166.diff","patch_url":"https://github.com/ember-learn/ember-cli-addon-docs/pull/166.patch"},"body":"This changes the way that we link to modules in order to make it more\r\ngeneric. The main difference here is that we no longer assume that the\r\nproject name has any relation to the module itself, instead we always\r\nuse the fully-qualified module name as its id, its link, and title.\r\n\r\nThere are some pros and cons to this approach:\r\n\r\n* Pros\r\n  * More inline with JS/modules as a whole - Since we base everything on\r\n  the full module name, we aren't basing it on arbitrary Ember-only\r\n  concepts, like the Addon/App folders, etc. The build system now just\r\n  receives a tree with a module structure, and assumes that it is the\r\n  correct, canonical structure.\r\n  * More self-documenting - users can know at a glance what the import\r\n  path for an item is just by looking at the sidebar\r\n  * Supports documenting multiple addons in a single project - this is\r\n  important for libraries like ember-decorators that are made up of many\r\n  small packages\r\n\r\n* Cons\r\n  * Slightly more verbose - the name of the addon is generally included\r\n  in titles, urls, and import paths, which can be redundant in the\r\n  simple case. This could be special-cased in the future, so we at least\r\n  don't include it in the title for the navigation index.\r\n  * Could be problematic with Node/Browser overlap - users could try to\r\n  have two sets of modules with identical import paths for both the\r\n  Browser and Node (e.g. both have an `index.js`). This is problematic\r\n  in general though, and moving forward Ember-CLI seems to be on a path\r\n  to making sure addons don't do this because its confusing.\r\n\r\nOther changes:\r\n\r\n* Instead of nesting modules under a `/root` url, we're now nesting them\r\nunder `/modules`, so we don't imply that it has anything to do with the\r\nstructure of the addon. Everything is just a JS module.\r\n* Fixed routing to resolvable items, components with similar names\r\nshould now work.\r\n* Removed module hoisting for now - it's fairly complex, and until we get\r\nall of the modules design and UX figured out I'd rather not be working with\r\nit as a constraint."},"comment":{"url":"https://api.github.com/repos/ember-learn/ember-cli-addon-docs/issues/comments/385739988","html_url":"https://github.com/ember-learn/ember-cli-addon-docs/pull/166#issuecomment-385739988","issue_url":"https://api.github.com/repos/ember-learn/ember-cli-addon-docs/issues/166","id":385739988,"user":{"login":"pzuraq","id":685518,"avatar_url":"https://avatars3.githubusercontent.com/u/685518?v=4","gravatar_id":"","url":"https://api.github.com/users/pzuraq","html_url":"https://github.com/pzuraq","followers_url":"https://api.github.com/users/pzuraq/followers","following_url":"https://api.github.com/users/pzuraq/following{/other_user}","gists_url":"https://api.github.com/users/pzuraq/gists{/gist_id}","starred_url":"https://api.github.com/users/pzuraq/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pzuraq/subscriptions","organizations_url":"https://api.github.com/users/pzuraq/orgs","repos_url":"https://api.github.com/users/pzuraq/repos","events_url":"https://api.github.com/users/pzuraq/events{/privacy}","received_events_url":"https://api.github.com/users/pzuraq/received_events","type":"User","site_admin":false},"created_at":"2018-05-01T17:55:10Z","updated_at":"2018-05-01T17:55:10Z","author_association":"CONTRIBUTOR","body":"Yeah, my plan is to fix that in a followup PR, didn't want to do too much at once. Should be able to get it up sometime this week!"}}
{"actor":{"display_login":"pzuraq"}}