{"action":"created","issue":{"url":"https://api.github.com/repos/bioconda/bioconda-recipes/issues/2915","repository_url":"https://api.github.com/repos/bioconda/bioconda-recipes","labels_url":"https://api.github.com/repos/bioconda/bioconda-recipes/issues/2915/labels{/name}","comments_url":"https://api.github.com/repos/bioconda/bioconda-recipes/issues/2915/comments","events_url":"https://api.github.com/repos/bioconda/bioconda-recipes/issues/2915/events","html_url":"https://github.com/bioconda/bioconda-recipes/issues/2915","id":188810807,"number":2915,"title":"docs overhaul","user":{"login":"daler","id":115406,"avatar_url":"https://avatars.githubusercontent.com/u/115406?v=3","gravatar_id":"","url":"https://api.github.com/users/daler","html_url":"https://github.com/daler","followers_url":"https://api.github.com/users/daler/followers","following_url":"https://api.github.com/users/daler/following{/other_user}","gists_url":"https://api.github.com/users/daler/gists{/gist_id}","starred_url":"https://api.github.com/users/daler/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/daler/subscriptions","organizations_url":"https://api.github.com/users/daler/orgs","repos_url":"https://api.github.com/users/daler/repos","events_url":"https://api.github.com/users/daler/events{/privacy}","received_events_url":"https://api.github.com/users/daler/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":5,"created_at":"2016-11-11T17:32:07Z","updated_at":"2016-11-22T02:50:55Z","closed_at":null,"body":"Currently we have documentation spread across:\r\n\r\n- `docs/index.rst` (hosted on bioconda.github.io/bioconda-recipes, along with package documentation)\r\n- README.md\r\n- GUIDELINES.md\r\n- FAQs.md\r\n- CONTRIBUTING.md\r\n\r\nThe first one is mostly just for users while the rest are for developers. It gets confusing, and we're lacking a single cohesive place to point folks for information.\r\n\r\nTo start addressing this I've started a docs overhaul which is currently hosted on https://daler.github.io/bioconda-docs. It recycles old content (mostly GUIDELINES and FAQs), but a major addition is a troubleshooting section with an annotated travis-ci log to help orient new contributors.\r\n\r\nNote that the simplified setup docs reflect the recent changes in #2914.\r\n\r\nAutomatically-generated pages for each package are missing from these new docs. We have enough packages now that the sphinx-built package pages and search is very clunky and not very useful IMHO for finding packages. Instead I think it would be nice to have something in client side javascript (DataTable?) that can be searched/filtered, and maybe even a d3.js DAG showing dependencies and reverse-dependencies of packages selected in the table.\r\n\r\nSo there are several things I'd like to get feedback on:\r\n\r\n1. The docs are currently under a separate repo `bioconda-docs` under my account. Moving them to the bioconda organization is trivial, but where should they eventually live? A separate `bioconda-docs` repo? Part of `bioconda-recipes`?\r\n\r\n2. How can be best make recipes discoverable and searchable? (ping @ewels )\r\n \r\n3. We need to document bioconda-utils as well. It's so tightly coupled to bioconda-recipes that one option would be to document it within these bioconda-recipes docs. I have a \"build system\" placeholder section for this. But it could also be argued that bioconda-utils docs should stay in the bioconda-utils repo. Any preferences on this?"},"comment":{"url":"https://api.github.com/repos/bioconda/bioconda-recipes/issues/comments/262133422","html_url":"https://github.com/bioconda/bioconda-recipes/issues/2915#issuecomment-262133422","issue_url":"https://api.github.com/repos/bioconda/bioconda-recipes/issues/2915","id":262133422,"user":{"login":"daler","id":115406,"avatar_url":"https://avatars.githubusercontent.com/u/115406?v=3","gravatar_id":"","url":"https://api.github.com/users/daler","html_url":"https://github.com/daler","followers_url":"https://api.github.com/users/daler/followers","following_url":"https://api.github.com/users/daler/following{/other_user}","gists_url":"https://api.github.com/users/daler/gists{/gist_id}","starred_url":"https://api.github.com/users/daler/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/daler/subscriptions","organizations_url":"https://api.github.com/users/daler/orgs","repos_url":"https://api.github.com/users/daler/repos","events_url":"https://api.github.com/users/daler/events{/privacy}","received_events_url":"https://api.github.com/users/daler/received_events","type":"User","site_admin":false},"created_at":"2016-11-22T02:50:55Z","updated_at":"2016-11-22T02:50:55Z","body":"Thanks, changed."}}
{"actor":{"display_login":"daler"}}