{"action":"opened","issue":{"url":"https://api.github.com/repos/phoenixframework/phoenix/issues/2493","repository_url":"https://api.github.com/repos/phoenixframework/phoenix","labels_url":"https://api.github.com/repos/phoenixframework/phoenix/issues/2493/labels{/name}","comments_url":"https://api.github.com/repos/phoenixframework/phoenix/issues/2493/comments","events_url":"https://api.github.com/repos/phoenixframework/phoenix/issues/2493/events","html_url":"https://github.com/phoenixframework/phoenix/issues/2493","id":257293961,"number":2493,"title":"Guides Overhaul","user":{"login":"Gazler","id":477511,"avatar_url":"https://avatars3.githubusercontent.com/u/477511?v=4","gravatar_id":"","url":"https://api.github.com/users/Gazler","html_url":"https://github.com/Gazler","followers_url":"https://api.github.com/users/Gazler/followers","following_url":"https://api.github.com/users/Gazler/following{/other_user}","gists_url":"https://api.github.com/users/Gazler/gists{/gist_id}","starred_url":"https://api.github.com/users/Gazler/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Gazler/subscriptions","organizations_url":"https://api.github.com/users/Gazler/orgs","repos_url":"https://api.github.com/users/Gazler/repos","events_url":"https://api.github.com/users/Gazler/events{/privacy}","received_events_url":"https://api.github.com/users/Gazler/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2017-09-13T08:14:51Z","updated_at":"2017-09-13T08:14:51Z","closed_at":null,"author_association":"MEMBER","body":"@chrismccord originally raised this issue on phoenix_guides\r\n\r\n---\r\n\r\nIt's time to pay down my guides debt with a review and overhaul of the guides and much needed TLC. \r\n\r\ncc @Gazler, @willykaram, @jeregrine \r\n\r\nHere's a shortlist to get us 1.3.0 stable ready. I'm marking the ones that I'm claiming, but others are up for grab if folks have bandwidth on refreshing the existing guides:\r\n\r\n* [x] Existing* guides in need of a refresh to include new features and latest conventions:\r\n  * [x] [@heatherm] Installation\r\n    * [x] needs to be bumped to 1.3 version requirements\r\n      * [x] Erlang 18\r\n      * [x] Elixir 1.5\r\n    * [x] needs to reference new `phx_new` archive urls\r\n    * [x] needs to use new `phx.new` task\r\n  * [x] Up And Running\r\n    * [x] needs to use new `phx.new`, `phx.server` tasks\r\n    * [x] all example output needs to be updated to new output\r\n  * [x] [CM] Adding Pages\r\n    * [x] needs to discuss new directory structure and update tree listings\r\n    * [x] needs to discuss new assets directory. `web/static` has moved to `assets`. `web/static/assets` has moved to `assets/static`, etc.\r\n    * [x] modules need to use new `Web` namespace\r\n    * [x] `Map.get(assigns, :messenger)` should be `assigns.messenger` since we've long raised on missing assigns\r\n    * [x] __new additions__\r\n      * [x] make small mention of EEx engine escaping by default when talking about templates (explained in detail later in Views guide, but should be mentioned here)\r\n  * [x] [@gazler] Routing\r\n    * [x] web namespace\r\n    * [x] needs to use `phx.routes` with new example output\r\n    * [x] __new additions__\r\n      * [x] cover basic `forward` usecases and usage\r\n  * [x] Plug\r\n    * [x] null-arity calls should use parens\r\n    * [x] web namespace in examples\r\n  * [x] Controllers\r\n    * [x] web namespaces\r\n    * [x] revamp code examples to follow conventions, such as always using parens when piping, no single line pipe.\r\n    * [x] __new additions__\r\n      * [x] discuss `halt` when talking about controller plugs and its importance to prevent invoking the controller action\r\n      * [x] action_fallback\r\n  * [x] Views\r\n    * [x] web namespaces\r\n    * [x] update file path locations\r\n    * [x] output of iex examples need refreshed\r\n    * [x] __new additions__\r\n      * [x] [CM] should show examples of functions on the view being available in eex templates and discuss why\r\n  * [ ] Channels\r\n    * [x] should cross-ref TBD presence guide at the end\r\n    * [x] web namespace\r\n    * [x] file paths\r\n    * [ ] should warn about using `handle_out` with potential N query problems\r\n    * [ ] linked `phoenix_chat_example` desperately needs overhaul to 1.3 and polished\r\n    * [ ] __new additions__\r\n      * [ ] needs to better discuss process-model on server\r\n      * [ ] needs to discuss `handle_info`\r\n      * [ ] Discuss channel security and auth, with examples (we can lift examples from generated socket.js file)\r\n      * [x] should cross-ref Phoenix.Token\r\n      * [ ] bonus points if we can show embedded gifs of examples as we go\r\n  * [x] [CM] Ecto Models (larger revisions required here compared to previous guides)\r\n    * [x] rename to Ecto Schemas\r\n    * [x] heavier focus on the purpose of schemas casting using input\r\n    * [x] use `phx.gen.schema` task\r\n    * [x] __new additions and major revisions__\r\n      * [x] do not discuss relationships in detail, deferring to context guide which will build off this example\r\n      * [x] close guide by discussing wrapping up Ecto repo access and queries into contexts, with TBD cross-ref\r\n  * [x] Testing Guides\r\n    * [x] blocked until context guide is written, which testing guides will build off of\r\n  * [ ] Deployment\r\n    * [ ] review Heroku and update for proper console update\r\n    * [x] update exrm guide to use distillery\r\n  * [x] Bonus Guides\r\n    * ...\r\n\r\n\r\n*New* guides needed for new features and lacking content:\r\n  * [x] [CM] Presence\r\n  * [ ] [CM]Umbrella applications\r\n  * [x] [CM] Contexts\r\n  * [x] `phx.gen.*` generators, some of these can be grouped into a larger guide, such as a guide on Ecto Schemas\r\n  * [x] Endpoint guide [@gazler] https://github.com/phoenixframework/phoenix_guides/pull/567\r\n\r\nOther items to tackle:\r\n  * move guide hosting over to hexdocs. Most of this work is in place, but we need to update the homepage of phoenixframework.org to link back to the hexdocs guides instead of readme hosting."}}
{"actor":{"display_login":"Gazler"}}