{"action":"opened","issue":{"url":"https://api.github.com/repos/cakephp/debug_kit/issues/372","labels_url":"https://api.github.com/repos/cakephp/debug_kit/issues/372/labels{/name}","comments_url":"https://api.github.com/repos/cakephp/debug_kit/issues/372/comments","events_url":"https://api.github.com/repos/cakephp/debug_kit/issues/372/events","html_url":"https://github.com/cakephp/debug_kit/issues/372","id":108584894,"number":372,"title":"Installation instructions are aimed at experienced/expert CakePHP users","user":{"login":"etfb","id":5212578,"avatar_url":"https://avatars.githubusercontent.com/u/5212578?v=3","gravatar_id":"","url":"https://api.github.com/users/etfb","html_url":"https://github.com/etfb","followers_url":"https://api.github.com/users/etfb/followers","following_url":"https://api.github.com/users/etfb/following{/other_user}","gists_url":"https://api.github.com/users/etfb/gists{/gist_id}","starred_url":"https://api.github.com/users/etfb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/etfb/subscriptions","organizations_url":"https://api.github.com/users/etfb/orgs","repos_url":"https://api.github.com/users/etfb/repos","events_url":"https://api.github.com/users/etfb/events{/privacy}","received_events_url":"https://api.github.com/users/etfb/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":0,"created_at":"2015-09-28T03:49:52Z","updated_at":"2015-09-28T03:49:52Z","closed_at":null,"body":"Picture if you will: a new CakePHP user, with a shiny new installation of PHP and Apache, installs CakePHP 2.x (because he happens to be working somewhere that requires 2.x for historical reasons).  Once he gets the salt sorted and the database configured, Cake tells him that it might be a good plan to install debug_kit.  Fair enough; off to github to grab it.  There's even an Installation section in the README, so that's nice. And what does it say?\r\n\r\n> Install the plugin with composer from your CakePHP Project's ROOT directory (where composer.json file is located)\r\n\r\nNo explanation of what \"composer\" [sic] is, and it's not spelt with a capital C so it's not immediately obvious that it's a product or tool.  A link to a Composer HOWTO would seem to be the absolute bare minimum requirement here.\r\n\r\n> Load the plugin\r\n\r\nA line of what might be PHP code here (the use of [] instead of array() is a recent innovation and one that not every newbie or even most tutorials will be aware of, and the :: makes it look more like C++ than anything. But more worryingly, there's no mention of where this line should be inserted!\r\n\r\n> Set 'debug' => true, in config/app.php.\r\n\r\nI was going to say that this, at least, is clear -- but the directory names are usually in initial-caps (Config, not config) and I can't see any file called app.php.  Is it maybe in debug_kit rather than in Cake?  I don't know; I haven't downloaded it yet.\r\n\r\nOK: the problem is simple,  You have a product that's advertised for use by newbs, before they've even created their first Cake app.  You have installation instructions that are not adequate for newbs, that require knowledge and experience (and more than a little proofreading).\r\n\r\nSuggestion: either fix the instructions, or advice the Cake project to postpone recommending debug_kit until after the rest of the tutorials."}}