{"action":"created","issue":{"url":"https://api.github.com/repos/keystonejs/keystone/issues/3296","repository_url":"https://api.github.com/repos/keystonejs/keystone","labels_url":"https://api.github.com/repos/keystonejs/keystone/issues/3296/labels{/name}","comments_url":"https://api.github.com/repos/keystonejs/keystone/issues/3296/comments","events_url":"https://api.github.com/repos/keystonejs/keystone/issues/3296/events","html_url":"https://github.com/keystonejs/keystone/issues/3296","id":170421683,"number":3296,"title":"Documentation revamp","user":{"login":"mxstbr","id":7525670,"avatar_url":"https://avatars.githubusercontent.com/u/7525670?v=3","gravatar_id":"","url":"https://api.github.com/users/mxstbr","html_url":"https://github.com/mxstbr","followers_url":"https://api.github.com/users/mxstbr/followers","following_url":"https://api.github.com/users/mxstbr/following{/other_user}","gists_url":"https://api.github.com/users/mxstbr/gists{/gist_id}","starred_url":"https://api.github.com/users/mxstbr/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mxstbr/subscriptions","organizations_url":"https://api.github.com/users/mxstbr/orgs","repos_url":"https://api.github.com/users/mxstbr/repos","events_url":"https://api.github.com/users/mxstbr/events{/privacy}","received_events_url":"https://api.github.com/users/mxstbr/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/keystonejs/keystone/labels/discussion","name":"discussion","color":"4a558a"}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":8,"created_at":"2016-08-10T13:48:56Z","updated_at":"2016-08-11T19:11:53Z","closed_at":null,"body":"TL;DR: We want to completely revamp the documentation, we're going to use [Gatsby](https://github.com/gatsbyjs/gatsby) for it and we need your help with guide writing!\r\n\r\nWe're planning to completely revamp the docs for the v4 release. @borisbozic is currently working on a complete redesign and we'll also change the way the documentation works and is structured.\r\n\r\nThese are the improvements we've come up with so far:\r\n\r\n- **Move documentation back into main repo**: We moved the documentation out of the main repo into `keystonejs-site` in an effort to keep this one lean and small. This backfired, as now the docs are out of date and not synced at all. Instead, we want to put the site in a different repo but generate the docs from Markdown files in this one. @kylematthews is going to help us set this up with Gatsby.js.\r\n- **Split documentation between API docs, Guides and technical docs**: Currently the documentation on the site is awesome if you're working _on_, but horrible if you're working _with_ Keystone. We need to split between user-facing docs (full-length guides, e.g. getting started, setting up a blog, setting up a portfolio site,… and API docs, i.e. how to use a certain field type) and development-facing docs (how the codebase is structured, how to set up a development version locally,…). A huge first start was made by @ostruzina and @dariasamo who migrated all the field type docs to this repo in #3261 and #3292, but this obviously isn't finished yet.\r\n\r\nThe main point where you can help is with guides. We want to have easy-to-follow guides for all common use cases and we need you to help us write them. **If you have a usecase and would be willing to write a short guide explaining how to set Keystone up for that please let us know in a comment!**\r\n\r\nIf you have any more suggestions on how we could improve the documentation please also let us know!"},"comment":{"url":"https://api.github.com/repos/keystonejs/keystone/issues/comments/239261184","html_url":"https://github.com/keystonejs/keystone/issues/3296#issuecomment-239261184","issue_url":"https://api.github.com/repos/keystonejs/keystone/issues/3296","id":239261184,"user":{"login":"mxstbr","id":7525670,"avatar_url":"https://avatars.githubusercontent.com/u/7525670?v=3","gravatar_id":"","url":"https://api.github.com/users/mxstbr","html_url":"https://github.com/mxstbr","followers_url":"https://api.github.com/users/mxstbr/followers","following_url":"https://api.github.com/users/mxstbr/following{/other_user}","gists_url":"https://api.github.com/users/mxstbr/gists{/gist_id}","starred_url":"https://api.github.com/users/mxstbr/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mxstbr/subscriptions","organizations_url":"https://api.github.com/users/mxstbr/orgs","repos_url":"https://api.github.com/users/mxstbr/repos","events_url":"https://api.github.com/users/mxstbr/events{/privacy}","received_events_url":"https://api.github.com/users/mxstbr/received_events","type":"User","site_admin":false},"created_at":"2016-08-11T19:11:53Z","updated_at":"2016-08-11T19:11:53Z","body":"All of this will be done by the actual rendering, you don't need to pay attention to anything in the markdown except to use proper headings and [fenced code blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/#fenced-code-blocks) :+1:\r\n\r\n```Md\r\n# My Guide\r\n\r\nThis is some content of my guide about keystone. Here is some information\r\n\r\n## Setup\r\n\r\nYou need to create a markdown file.\r\n```"}}
{"actor":{"display_login":"mxstbr"}}