{"action":"created","issue":{"url":"https://api.github.com/repos/neurodata/ndstore/issues/174","repository_url":"https://api.github.com/repos/neurodata/ndstore","labels_url":"https://api.github.com/repos/neurodata/ndstore/issues/174/labels{/name}","comments_url":"https://api.github.com/repos/neurodata/ndstore/issues/174/comments","events_url":"https://api.github.com/repos/neurodata/ndstore/issues/174/events","html_url":"https://github.com/neurodata/ndstore/issues/174","id":115542929,"number":174,"title":"documentation bugs/questions","user":{"login":"jovo","id":41842,"avatar_url":"https://avatars.githubusercontent.com/u/41842?v=3","gravatar_id":"","url":"https://api.github.com/users/jovo","html_url":"https://github.com/jovo","followers_url":"https://api.github.com/users/jovo/followers","following_url":"https://api.github.com/users/jovo/following{/other_user}","gists_url":"https://api.github.com/users/jovo/gists{/gist_id}","starred_url":"https://api.github.com/users/jovo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jovo/subscriptions","organizations_url":"https://api.github.com/users/jovo/orgs","repos_url":"https://api.github.com/users/jovo/repos","events_url":"https://api.github.com/users/jovo/events{/privacy}","received_events_url":"https://api.github.com/users/jovo/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":{"login":"kunallillaney","id":1380214,"avatar_url":"https://avatars.githubusercontent.com/u/1380214?v=3","gravatar_id":"","url":"https://api.github.com/users/kunallillaney","html_url":"https://github.com/kunallillaney","followers_url":"https://api.github.com/users/kunallillaney/followers","following_url":"https://api.github.com/users/kunallillaney/following{/other_user}","gists_url":"https://api.github.com/users/kunallillaney/gists{/gist_id}","starred_url":"https://api.github.com/users/kunallillaney/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kunallillaney/subscriptions","organizations_url":"https://api.github.com/users/kunallillaney/orgs","repos_url":"https://api.github.com/users/kunallillaney/repos","events_url":"https://api.github.com/users/kunallillaney/events{/privacy}","received_events_url":"https://api.github.com/users/kunallillaney/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/neurodata/ndstore/milestones/6","html_url":"https://github.com/neurodata/ndstore/milestones/2016_01_15","labels_url":"https://api.github.com/repos/neurodata/ndstore/milestones/6/labels","id":1465631,"number":6,"title":"2016_01_15","description":"","creator":{"login":"jovo","id":41842,"avatar_url":"https://avatars.githubusercontent.com/u/41842?v=3","gravatar_id":"","url":"https://api.github.com/users/jovo","html_url":"https://github.com/jovo","followers_url":"https://api.github.com/users/jovo/followers","following_url":"https://api.github.com/users/jovo/following{/other_user}","gists_url":"https://api.github.com/users/jovo/gists{/gist_id}","starred_url":"https://api.github.com/users/jovo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jovo/subscriptions","organizations_url":"https://api.github.com/users/jovo/orgs","repos_url":"https://api.github.com/users/jovo/repos","events_url":"https://api.github.com/users/jovo/events{/privacy}","received_events_url":"https://api.github.com/users/jovo/received_events","type":"User","site_admin":false},"open_issues":1,"closed_issues":4,"state":"open","created_at":"2015-12-17T19:34:27Z","updated_at":"2016-04-27T02:49:14Z","due_on":"2016-01-18T05:00:00Z","closed_at":null},"comments":18,"created_at":"2015-11-06T16:44:50Z","updated_at":"2016-06-07T16:07:12Z","closed_at":null,"body":"- [ ] all remaining TODOs\r\n\r\n# Intro and Data Model\r\n  [ ] @kunallillaney update http://docs.neurodata.io/ndstore/_images/nd_cluster.png \r\n- [ ] \"Configuration\" is obviously not done.  but randal has a docker box, maybe just link to that instead? uEdit: @kunallillaney I vote this becomes a link to https://github.com/neurodata/ndinstall\r\n- [ ] in [this](http://docs.neurodata.io/open-connectome/sphinx/datamodel.html), the lists do not render as a list @Aeusman this wasn't fixed\r\n- [ ] when defining dataset, it is really important to make clear (in bold) that dataset does *not* contain any data in it, only metadata for a given dataset.\r\n\r\n\r\n# Meta API comments:\r\n\r\n- [ ] i don't understand the examples. in particular, i don't know where to type that stuff, or whether even? i also don't know how to search for the answer.  maybe a general API section that could explain it once would be really helpful. -uEdit: I wrote a simple general_api page which just says \"All of the APIs enumerated here are RESTful calls that are used via the browser or calls to the web service. For additional usage information see online RESTful documentation\", but this seems excessive to include an extra page for unless there is other information we need to include? @jovo  @Aeusman put in FAQ perhaps?\r\n- [ ] make sure each API has a very clear & complete synopsis\r\n\r\n\r\n# Data APIs\r\nuEdit: I believe this is a @kunallillaney area, I haven't worked with this interface very much/at all. \r\n- [ ] maybe a sentence at the top explaining we support 3 different ways of posting cubes, and 2 different ways to post image slices?  \r\n- [ ] also can say up there that the  difference between hdf5, blosc, and numpy in the url is simply whether to write hdf5, blosc, or numpy?\r\n- [ ] maybe also explain best practices here? like, do we recommend blosc? and power of 2 cutouts? etc.\r\n- [ ] please clarify what \"Form Parameters\" means\r\n- [ ] \"The order which post data is zyx\"  this seems important? is it mentioned anywhere else? if not, maybe it should be mentioned somewhere other than in the example comments?\r\n- [ ] \"post_data\" has both hdf5 & numpy, let's clarify before the example that it does both\r\n- [ ] \"/ocp/ca/kasthuri11/image/xz/0/9000,9500/12000/50,250/ HTTP/1.1\" the image is too long.  can we just use a shorter one? same with 'yz' image.\r\n\r\n# RAMON API\r\nuEdit: @willgray or @kunallillaney I'm not sure who is documenting here,  but I don't have sufficient knowledge for this.\r\n- [ ] examples everything here please \r\n- [ ] \"query object service\" ?\r\n- [ ] do we have undo now? is it documented?\r\n\r\n# Propagate\r\n\r\n- [ ] \"propagate_value\" - uEdit: What is the issue with this? @jovo  @Aeusman it is listed twice.\r\n\r\n# JSON API\r\n\r\n@Aeusman i don't think you did these?\r\n- [ ] autoIngest - link to tech sheet, or embed it\r\n- [ ] maybe also link to generatejason, or the docs on ingest?\r\n\r\n# Overlay API\r\n-uEdit: @kunallillaney or @j6k4m8 I'm not sure which\r\n\r\n- [ ] example for GET XY Slice Cutout\r\n- [ ] seems like that should be called \"GET XY Overlay Cutout\"\r\n\r\n# Tile APIs \r\n- uEdit: @kunallillaney \r\n- [ ] i think this is a data api, i understand why it is documented separately, but i think that will be confusing for people, and i would just put these under the Data API heading.  for example, the Viking stuff is here, but the KNOSSOS stuff is there. @Aeusman i don't know what you did here.  i was suggesting that these APIs be incorporated into data API.  \r\n- [ ] getMcfcTile, i'm not sure how this is different from getSimpleTile, please clarify @Aeusman color. clarify.\r\n- [ ] getVikingTile: this is just for using with Viking? Let's say that and link to [Viking](https://connectomes.utah.edu/)\r\n\r\n# Extract Graph API\r\n\r\n- [ ] not clear how it works @Aeusman \r\n\r\n# NIFTI API\r\n\r\n- [ ] make right @gkiar @randalburns \r\n\r\n# SWC API\r\n\r\n- [ ] make right @gkiar @randalburns \r\n\r\n\r\n# Other stuff\r\n\r\n- [ ] remove \"open-connectome Functions\", \"Gitter\" \r\n- [ ] window isn't documented anywhere? @randalburns \r\n- [ ] 'oldchannel' is not listed as a type, but we use it, so we should document it (even if it is depricated), so that people knows it exists and is an option, and what it means. - uEdit: @kunallillaney until there are no more channels of that type, it should be listed as a deprecated & documented.\r\n- [ ] i think we should collect all the API's together into a single \"API\" heading, with appropriate subheadings.  then, we could link directly to the API from the homepage, and separately link to \"Tutorials\" for the other stuff. thoughts?  - uEdit: Reorganized into NeuroData Documentation and API Documeation on index page. Moved API help to top of list. @Aeusman this did not get merged in."},"comment":{"url":"https://api.github.com/repos/neurodata/ndstore/issues/comments/224329886","html_url":"https://github.com/neurodata/ndstore/issues/174#issuecomment-224329886","issue_url":"https://api.github.com/repos/neurodata/ndstore/issues/174","id":224329886,"user":{"login":"jovo","id":41842,"avatar_url":"https://avatars.githubusercontent.com/u/41842?v=3","gravatar_id":"","url":"https://api.github.com/users/jovo","html_url":"https://github.com/jovo","followers_url":"https://api.github.com/users/jovo/followers","following_url":"https://api.github.com/users/jovo/following{/other_user}","gists_url":"https://api.github.com/users/jovo/gists{/gist_id}","starred_url":"https://api.github.com/users/jovo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jovo/subscriptions","organizations_url":"https://api.github.com/users/jovo/orgs","repos_url":"https://api.github.com/users/jovo/repos","events_url":"https://api.github.com/users/jovo/events{/privacy}","received_events_url":"https://api.github.com/users/jovo/received_events","type":"User","site_admin":false},"created_at":"2016-06-07T16:07:12Z","updated_at":"2016-06-07T16:07:12Z","body":"does this mean the site was updated?\n\nOn Tuesday, June 7, 2016, Alex Eusman <notifications@github.com> wrote:\n\n> http://docs.neurodata.io/ndstore/sphinx/ingesting.html\n>\n> —\n> You are receiving this because you were mentioned.\n> Reply to this email directly, view it on GitHub\n> <https://github.com/neurodata/ndstore/issues/174#issuecomment-224325853>,\n> or mute the thread\n> <https://github.com/notifications/unsubscribe/AACjcoM-balYg-hyLh-c0REuXncyXNEQks5qJZRMgaJpZM4Gdjv6>\n> .\n>\n\n\n-- \nthe glass is all full:  half water, half air.\nneurodata.io, jovo calendar\n<https://calendar.google.com/calendar/embed?src=joshuav%40gmail.com&ctz=America/New_York>\n"}}
{"actor":{"display_login":"jovo"}}