{"action":"created","issue":{"url":"https://api.github.com/repos/sscarduzio/elasticsearch-readonlyrest-plugin/issues/40","repository_url":"https://api.github.com/repos/sscarduzio/elasticsearch-readonlyrest-plugin","labels_url":"https://api.github.com/repos/sscarduzio/elasticsearch-readonlyrest-plugin/issues/40/labels{/name}","comments_url":"https://api.github.com/repos/sscarduzio/elasticsearch-readonlyrest-plugin/issues/40/comments","events_url":"https://api.github.com/repos/sscarduzio/elasticsearch-readonlyrest-plugin/issues/40/events","html_url":"https://github.com/sscarduzio/elasticsearch-readonlyrest-plugin/issues/40","id":145230525,"number":40,"title":"Cookbook style documentation","user":{"login":"sscarduzio","id":1327189,"avatar_url":"https://avatars.githubusercontent.com/u/1327189?v=3","gravatar_id":"","url":"https://api.github.com/users/sscarduzio","html_url":"https://github.com/sscarduzio","followers_url":"https://api.github.com/users/sscarduzio/followers","following_url":"https://api.github.com/users/sscarduzio/following{/other_user}","gists_url":"https://api.github.com/users/sscarduzio/gists{/gist_id}","starred_url":"https://api.github.com/users/sscarduzio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sscarduzio/subscriptions","organizations_url":"https://api.github.com/users/sscarduzio/orgs","repos_url":"https://api.github.com/users/sscarduzio/repos","events_url":"https://api.github.com/users/sscarduzio/events{/privacy}","received_events_url":"https://api.github.com/users/sscarduzio/received_events","type":"User","site_admin":false},"labels":[{"id":69406713,"url":"https://api.github.com/repos/sscarduzio/elasticsearch-readonlyrest-plugin/labels/enhancement","name":"enhancement","color":"84b6eb","default":true},{"id":357364090,"url":"https://api.github.com/repos/sscarduzio/elasticsearch-readonlyrest-plugin/labels/help-wanted","name":"help-wanted","color":"d93f0b","default":false}],"state":"open","locked":false,"assignee":{"login":"sscarduzio","id":1327189,"avatar_url":"https://avatars.githubusercontent.com/u/1327189?v=3","gravatar_id":"","url":"https://api.github.com/users/sscarduzio","html_url":"https://github.com/sscarduzio","followers_url":"https://api.github.com/users/sscarduzio/followers","following_url":"https://api.github.com/users/sscarduzio/following{/other_user}","gists_url":"https://api.github.com/users/sscarduzio/gists{/gist_id}","starred_url":"https://api.github.com/users/sscarduzio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sscarduzio/subscriptions","organizations_url":"https://api.github.com/users/sscarduzio/orgs","repos_url":"https://api.github.com/users/sscarduzio/repos","events_url":"https://api.github.com/users/sscarduzio/events{/privacy}","received_events_url":"https://api.github.com/users/sscarduzio/received_events","type":"User","site_admin":false},"assignees":[{"login":"sscarduzio","id":1327189,"avatar_url":"https://avatars.githubusercontent.com/u/1327189?v=3","gravatar_id":"","url":"https://api.github.com/users/sscarduzio","html_url":"https://github.com/sscarduzio","followers_url":"https://api.github.com/users/sscarduzio/followers","following_url":"https://api.github.com/users/sscarduzio/following{/other_user}","gists_url":"https://api.github.com/users/sscarduzio/gists{/gist_id}","starred_url":"https://api.github.com/users/sscarduzio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sscarduzio/subscriptions","organizations_url":"https://api.github.com/users/sscarduzio/orgs","repos_url":"https://api.github.com/users/sscarduzio/repos","events_url":"https://api.github.com/users/sscarduzio/events{/privacy}","received_events_url":"https://api.github.com/users/sscarduzio/received_events","type":"User","site_admin":false}],"milestone":null,"comments":3,"created_at":"2016-04-01T16:56:25Z","updated_at":"2017-01-31T11:33:30Z","closed_at":null,"body":"Write a series of wiki pages to show off various use cases, their description and their solution.\nLink the recipes in the main README.md (which needs to be much smaller).\n"},"comment":{"url":"https://api.github.com/repos/sscarduzio/elasticsearch-readonlyrest-plugin/issues/comments/276340777","html_url":"https://github.com/sscarduzio/elasticsearch-readonlyrest-plugin/issues/40#issuecomment-276340777","issue_url":"https://api.github.com/repos/sscarduzio/elasticsearch-readonlyrest-plugin/issues/40","id":276340777,"user":{"login":"sscarduzio","id":1327189,"avatar_url":"https://avatars.githubusercontent.com/u/1327189?v=3","gravatar_id":"","url":"https://api.github.com/users/sscarduzio","html_url":"https://github.com/sscarduzio","followers_url":"https://api.github.com/users/sscarduzio/followers","following_url":"https://api.github.com/users/sscarduzio/following{/other_user}","gists_url":"https://api.github.com/users/sscarduzio/gists{/gist_id}","starred_url":"https://api.github.com/users/sscarduzio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sscarduzio/subscriptions","organizations_url":"https://api.github.com/users/sscarduzio/orgs","repos_url":"https://api.github.com/users/sscarduzio/repos","events_url":"https://api.github.com/users/sscarduzio/events{/privacy}","received_events_url":"https://api.github.com/users/sscarduzio/received_events","type":"User","site_admin":false},"created_at":"2017-01-31T11:33:30Z","updated_at":"2017-01-31T11:33:30Z","body":"Yay, more volunteers! \r\n\r\nBasic guide lines about what I mean with cookbook style:\r\n\r\n## Structure\r\n* Title = description of the end result\r\n* Brief intro about what real business case are you solving with this solution\r\n* Present the shiny final result (screenshot helps)\r\n* List the ingredients: software versions used, state if the reader needs anything specific (i.e. a cookbook about Letsencrypt SSL would need a public IP).\r\n* Step by step instructions until the final result. If it's long, break the list down into phases using nested headings: i.e. \r\n```md\r\n## Download and install the plugin\", \"Configure Kibana\", etc.\r\nbla bla\r\n### Downloading the plugin for your version\r\nbla bla\r\n### Installing the plugin\r\nbla bla\r\n```\r\n\r\n### General Tips\r\n-  People love copy-paste code snippets and screenshots. Use the triple-backticks + language name to have nice looking snippets\r\ni.e.\r\n```bash\r\n$ ls $ES_HOME\r\n```\r\nAnd for Yaml too:\r\n\r\n```yaml\r\nreadonlyrest:\r\n    enable: true\r\n    ssl:\r\n      enable: true\r\n```\r\n- Use the project's wiki to compose a document in Github flavored markdown. I have a templating system that mocks 100% GH markdown, it's going to look great!\r\n\r\n\r\n"}}
{"actor":{"display_login":"sscarduzio"}}