{"action":"created","issue":{"url":"https://api.github.com/repos/reed-college/strabo/issues/40","repository_url":"https://api.github.com/repos/reed-college/strabo","labels_url":"https://api.github.com/repos/reed-college/strabo/issues/40/labels{/name}","comments_url":"https://api.github.com/repos/reed-college/strabo/issues/40/comments","events_url":"https://api.github.com/repos/reed-college/strabo/issues/40/events","html_url":"https://github.com/reed-college/strabo/issues/40","id":168001046,"number":40,"title":"Documentation","user":{"login":"weepingwillowben","id":10835669,"avatar_url":"https://avatars.githubusercontent.com/u/10835669?v=3","gravatar_id":"","url":"https://api.github.com/users/weepingwillowben","html_url":"https://github.com/weepingwillowben","followers_url":"https://api.github.com/users/weepingwillowben/followers","following_url":"https://api.github.com/users/weepingwillowben/following{/other_user}","gists_url":"https://api.github.com/users/weepingwillowben/gists{/gist_id}","starred_url":"https://api.github.com/users/weepingwillowben/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/weepingwillowben/subscriptions","organizations_url":"https://api.github.com/users/weepingwillowben/orgs","repos_url":"https://api.github.com/users/weepingwillowben/repos","events_url":"https://api.github.com/users/weepingwillowben/events{/privacy}","received_events_url":"https://api.github.com/users/weepingwillowben/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":4,"created_at":"2016-07-28T02:32:08Z","updated_at":"2016-07-28T17:55:26Z","closed_at":null,"body":"Due to the success of discussing the about page over a github issue, I thought I would explain my broad sorts of ideas for documentation. \r\n\r\nI think that the documentation should be clearly divided into the three sections below. The idea behind this is pulled from [https://jacobian.org/writing/what-to-write/].\r\n\r\nHaving the first section clearly separated from the rest is especially important, as the target audience is different. \r\n\r\n#### For people who only want to run strabo (getting started tutorial):\r\n\r\n* installation/setup guide\r\n* configuration guide\r\n* issues help guide\r\n\r\n#### For people who want to learn about how strabo works and want to have a broad overview of the  more unique qualities of our code so that they have a better sense of what is happening (topic documentation):\r\n\r\n* Image file uploading/resizing/naming scheme\r\n* Interest point and straboconfig data path.\r\n* Form validation/submission.\r\n\r\n#### For people who want to change strabo and want to know what each function accepts as input and returns(reference):\r\n\r\n* root files\r\n   * runserver.py\r\n   * initdb.py\r\n   * etc..\r\n* strabo files\r\n    * geojson_wrapper.py\r\n    * etc.\r\n* strabo.view files\r\n   * public.py\r\n   * private.py\r\n* javascript files\r\n   * map.js\r\n   * etc."},"comment":{"url":"https://api.github.com/repos/reed-college/strabo/issues/comments/235973505","html_url":"https://github.com/reed-college/strabo/issues/40#issuecomment-235973505","issue_url":"https://api.github.com/repos/reed-college/strabo/issues/40","id":235973505,"user":{"login":"weepingwillowben","id":10835669,"avatar_url":"https://avatars.githubusercontent.com/u/10835669?v=3","gravatar_id":"","url":"https://api.github.com/users/weepingwillowben","html_url":"https://github.com/weepingwillowben","followers_url":"https://api.github.com/users/weepingwillowben/followers","following_url":"https://api.github.com/users/weepingwillowben/following{/other_user}","gists_url":"https://api.github.com/users/weepingwillowben/gists{/gist_id}","starred_url":"https://api.github.com/users/weepingwillowben/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/weepingwillowben/subscriptions","organizations_url":"https://api.github.com/users/weepingwillowben/orgs","repos_url":"https://api.github.com/users/weepingwillowben/repos","events_url":"https://api.github.com/users/weepingwillowben/events{/privacy}","received_events_url":"https://api.github.com/users/weepingwillowben/received_events","type":"User","site_admin":false},"created_at":"2016-07-28T17:55:26Z","updated_at":"2016-07-28T17:55:26Z","body":"Yeah, I was wondering the same thing. I tried that approach for form validation and I think it turned out rather well. The only thing I struggle with is that in some cases, it doesn't make sense to put some of this material under a specific file because it encompasses multiple files by necessity (either encompassing both python/jinja templates/javascript or both strabo and root folder files). And so I am inclined to separate all of them for consistency. A compromise solution is having the 2nd part link to the specific functions that implement the features described, to get the best of both worlds. It is kind of clunky, though, so I am still not sure about this. "}}
{"actor":{"display_login":"weepingwillowben"}}