{"action":"created","issue":{"url":"https://api.github.com/repos/cubing/worldcubeassociation.org/issues/603","repository_url":"https://api.github.com/repos/cubing/worldcubeassociation.org","labels_url":"https://api.github.com/repos/cubing/worldcubeassociation.org/issues/603/labels{/name}","comments_url":"https://api.github.com/repos/cubing/worldcubeassociation.org/issues/603/comments","events_url":"https://api.github.com/repos/cubing/worldcubeassociation.org/issues/603/events","html_url":"https://github.com/cubing/worldcubeassociation.org/issues/603","id":154025722,"number":603,"title":"Document the process for adding a translation of the website","user":{"login":"viroulep","id":1007485,"avatar_url":"https://avatars.githubusercontent.com/u/1007485?v=3","gravatar_id":"","url":"https://api.github.com/users/viroulep","html_url":"https://github.com/viroulep","followers_url":"https://api.github.com/users/viroulep/followers","following_url":"https://api.github.com/users/viroulep/following{/other_user}","gists_url":"https://api.github.com/users/viroulep/gists{/gist_id}","starred_url":"https://api.github.com/users/viroulep/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/viroulep/subscriptions","organizations_url":"https://api.github.com/users/viroulep/orgs","repos_url":"https://api.github.com/users/viroulep/repos","events_url":"https://api.github.com/users/viroulep/events{/privacy}","received_events_url":"https://api.github.com/users/viroulep/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/cubing/worldcubeassociation.org/labels/i18n","name":"i18n","color":"f9d0c4"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":8,"created_at":"2016-05-10T14:49:51Z","updated_at":"2016-05-15T20:37:13Z","closed_at":null,"body":"In the end we'll need some documentation to make the job of the translators easy.\r\n\r\nThis include:\r\n * write something somewhere (wiki ?) describing the process\r\n * preparing a list of files to translate\r\n * comment these files to give some context for the use of the translation"},"comment":{"url":"https://api.github.com/repos/cubing/worldcubeassociation.org/issues/comments/219309072","html_url":"https://github.com/cubing/worldcubeassociation.org/issues/603#issuecomment-219309072","issue_url":"https://api.github.com/repos/cubing/worldcubeassociation.org/issues/603","id":219309072,"user":{"login":"viroulep","id":1007485,"avatar_url":"https://avatars.githubusercontent.com/u/1007485?v=3","gravatar_id":"","url":"https://api.github.com/users/viroulep","html_url":"https://github.com/viroulep","followers_url":"https://api.github.com/users/viroulep/followers","following_url":"https://api.github.com/users/viroulep/following{/other_user}","gists_url":"https://api.github.com/users/viroulep/gists{/gist_id}","starred_url":"https://api.github.com/users/viroulep/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/viroulep/subscriptions","organizations_url":"https://api.github.com/users/viroulep/orgs","repos_url":"https://api.github.com/users/viroulep/repos","events_url":"https://api.github.com/users/viroulep/events{/privacy}","received_events_url":"https://api.github.com/users/viroulep/received_events","type":"User","site_admin":false},"created_at":"2016-05-15T20:37:13Z","updated_at":"2016-05-15T20:37:13Z","body":"One step to make the translator job easier would be to have a clearly structured layout for the yml file.\r\n\r\nRight now I've chosen simplicity for the developer instead of simplicity for the translator (ie: I wrote the yml depending on the rails context where the key is used).\r\n\r\nOne way to layout the yml could be:\r\n\r\n```yml\r\nen:\r\n  controllerX:\r\n    errors:\r\n      wrong: \"Something wrong\"\r\n    flash:\r\n      login: \"Please login\"\r\n    form:\r\n      somefield: \"Some additional hint\"\r\n    messages:\r\n      someinfo: \"Some non-flash info displayed on top\"\r\n    navigation:\r\n      home: \"Home\"\r\n    text:\r\n      page_description: \"Some long text that may have %{variable} and that does not fit elsewhere\"\r\n  # etc for other controllers\r\n  activerecord:\r\n  # The activerecord things\r\n  simple_form:\r\n  # The simple_form things\r\n```\r\n\r\nWe should probably keep the `activerecord` and `simple_form`, it's very convenient and pretty straightforward to understand."}}