{"action":"created","issue":{"url":"https://api.github.com/repos/opf/openproject/issues/3341","labels_url":"https://api.github.com/repos/opf/openproject/issues/3341/labels{/name}","comments_url":"https://api.github.com/repos/opf/openproject/issues/3341/comments","events_url":"https://api.github.com/repos/opf/openproject/issues/3341/events","html_url":"https://github.com/opf/openproject/pull/3341","id":100302444,"number":3341,"title":"Frontend documentation","user":{"login":"floriank","id":498241,"avatar_url":"https://avatars.githubusercontent.com/u/498241?v=3","gravatar_id":"","url":"https://api.github.com/users/floriank","html_url":"https://github.com/floriank","followers_url":"https://api.github.com/users/floriank/followers","following_url":"https://api.github.com/users/floriank/following{/other_user}","gists_url":"https://api.github.com/users/floriank/gists{/gist_id}","starred_url":"https://api.github.com/users/floriank/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/floriank/subscriptions","organizations_url":"https://api.github.com/users/floriank/orgs","repos_url":"https://api.github.com/users/floriank/repos","events_url":"https://api.github.com/users/floriank/events{/privacy}","received_events_url":"https://api.github.com/users/floriank/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/opf/openproject/labels/documentation","name":"documentation","color":"c7def8"},{"url":"https://api.github.com/repos/opf/openproject/labels/work%20in%20progress","name":"work in progress","color":"eb6420"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":11,"created_at":"2015-08-11T12:39:55Z","updated_at":"2015-08-14T11:49:29Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/opf/openproject/pulls/3341","html_url":"https://github.com/opf/openproject/pull/3341","diff_url":"https://github.com/opf/openproject/pull/3341.diff","patch_url":"https://github.com/opf/openproject/pull/3341.patch"},"body":"This will add desperately needed documentation for frontend-related topics for OpenProject.\r\n\r\nThe main concern here is to:\r\n\r\n- document the processes involved with building the frontend\r\n- convey information on trap doors and dark corners of the frontend code\r\n- document any quirks and tools that are used throughout the process.\r\n\r\nInitially, this will cover the AngularJS parts of the frontend. Ideally however, this will also cover some of the legacy codebase found in the dark reaches of places like `application.js.erb`.\r\n\r\nPlease look out for interesting grammar and typos - I am not the best playwright in the world, despite contrary information."},"comment":{"url":"https://api.github.com/repos/opf/openproject/issues/comments/131085384","html_url":"https://github.com/opf/openproject/pull/3341#issuecomment-131085384","issue_url":"https://api.github.com/repos/opf/openproject/issues/3341","id":131085384,"user":{"login":"NobodysNightmare","id":453584,"avatar_url":"https://avatars.githubusercontent.com/u/453584?v=3","gravatar_id":"","url":"https://api.github.com/users/NobodysNightmare","html_url":"https://github.com/NobodysNightmare","followers_url":"https://api.github.com/users/NobodysNightmare/followers","following_url":"https://api.github.com/users/NobodysNightmare/following{/other_user}","gists_url":"https://api.github.com/users/NobodysNightmare/gists{/gist_id}","starred_url":"https://api.github.com/users/NobodysNightmare/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/NobodysNightmare/subscriptions","organizations_url":"https://api.github.com/users/NobodysNightmare/orgs","repos_url":"https://api.github.com/users/NobodysNightmare/repos","events_url":"https://api.github.com/users/NobodysNightmare/events{/privacy}","received_events_url":"https://api.github.com/users/NobodysNightmare/received_events","type":"User","site_admin":false},"created_at":"2015-08-14T11:49:29Z","updated_at":"2015-08-14T11:49:29Z","body":"I had a quick fly-by, looking nice.\r\n\r\nonly question for me is the rooting:\r\n\r\nShould it be `frontend/doc`? (pro: some day we might want to split frontend/backend into separate repos)\r\nShould it be `doc/frontend`? (pro: that is where everything else lives that is documentation -> discoverability)"}}