{"action":"created","issue":{"url":"https://api.github.com/repos/cernanalysispreservation/analysis-preservation.cern.ch/issues/411","repository_url":"https://api.github.com/repos/cernanalysispreservation/analysis-preservation.cern.ch","labels_url":"https://api.github.com/repos/cernanalysispreservation/analysis-preservation.cern.ch/issues/411/labels{/name}","comments_url":"https://api.github.com/repos/cernanalysispreservation/analysis-preservation.cern.ch/issues/411/comments","events_url":"https://api.github.com/repos/cernanalysispreservation/analysis-preservation.cern.ch/issues/411/events","html_url":"https://github.com/cernanalysispreservation/analysis-preservation.cern.ch/issues/411","id":200133856,"number":411,"title":"docs: structure","user":{"login":"Kjili","id":5553636,"avatar_url":"https://avatars.githubusercontent.com/u/5553636?v=3","gravatar_id":"","url":"https://api.github.com/users/Kjili","html_url":"https://github.com/Kjili","followers_url":"https://api.github.com/users/Kjili/followers","following_url":"https://api.github.com/users/Kjili/following{/other_user}","gists_url":"https://api.github.com/users/Kjili/gists{/gist_id}","starred_url":"https://api.github.com/users/Kjili/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Kjili/subscriptions","organizations_url":"https://api.github.com/users/Kjili/orgs","repos_url":"https://api.github.com/users/Kjili/repos","events_url":"https://api.github.com/users/Kjili/events{/privacy}","received_events_url":"https://api.github.com/users/Kjili/received_events","type":"User","site_admin":false},"labels":[{"id":512241071,"url":"https://api.github.com/repos/cernanalysispreservation/analysis-preservation.cern.ch/labels/Documentation:%20user","name":"Documentation: user","color":"009800","default":false},{"id":100864962,"url":"https://api.github.com/repos/cernanalysispreservation/analysis-preservation.cern.ch/labels/Type:%20discussion","name":"Type: discussion","color":"ffaa00","default":false}],"state":"open","locked":false,"assignee":{"login":"xchen101","id":3393596,"avatar_url":"https://avatars.githubusercontent.com/u/3393596?v=3","gravatar_id":"","url":"https://api.github.com/users/xchen101","html_url":"https://github.com/xchen101","followers_url":"https://api.github.com/users/xchen101/followers","following_url":"https://api.github.com/users/xchen101/following{/other_user}","gists_url":"https://api.github.com/users/xchen101/gists{/gist_id}","starred_url":"https://api.github.com/users/xchen101/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/xchen101/subscriptions","organizations_url":"https://api.github.com/users/xchen101/orgs","repos_url":"https://api.github.com/users/xchen101/repos","events_url":"https://api.github.com/users/xchen101/events{/privacy}","received_events_url":"https://api.github.com/users/xchen101/received_events","type":"User","site_admin":false},"assignees":[{"login":"xchen101","id":3393596,"avatar_url":"https://avatars.githubusercontent.com/u/3393596?v=3","gravatar_id":"","url":"https://api.github.com/users/xchen101","html_url":"https://github.com/xchen101","followers_url":"https://api.github.com/users/xchen101/followers","following_url":"https://api.github.com/users/xchen101/following{/other_user}","gists_url":"https://api.github.com/users/xchen101/gists{/gist_id}","starred_url":"https://api.github.com/users/xchen101/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/xchen101/subscriptions","organizations_url":"https://api.github.com/users/xchen101/orgs","repos_url":"https://api.github.com/users/xchen101/repos","events_url":"https://api.github.com/users/xchen101/events{/privacy}","received_events_url":"https://api.github.com/users/xchen101/received_events","type":"User","site_admin":false}],"milestone":{"url":"https://api.github.com/repos/cernanalysispreservation/analysis-preservation.cern.ch/milestones/29","html_url":"https://github.com/cernanalysispreservation/analysis-preservation.cern.ch/milestone/29","labels_url":"https://api.github.com/repos/cernanalysispreservation/analysis-preservation.cern.ch/milestones/29/labels","id":2198955,"number":29,"title":"User Documentation","description":"","creator":{"login":"Kjili","id":5553636,"avatar_url":"https://avatars.githubusercontent.com/u/5553636?v=3","gravatar_id":"","url":"https://api.github.com/users/Kjili","html_url":"https://github.com/Kjili","followers_url":"https://api.github.com/users/Kjili/followers","following_url":"https://api.github.com/users/Kjili/following{/other_user}","gists_url":"https://api.github.com/users/Kjili/gists{/gist_id}","starred_url":"https://api.github.com/users/Kjili/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Kjili/subscriptions","organizations_url":"https://api.github.com/users/Kjili/orgs","repos_url":"https://api.github.com/users/Kjili/repos","events_url":"https://api.github.com/users/Kjili/events{/privacy}","received_events_url":"https://api.github.com/users/Kjili/received_events","type":"User","site_admin":false},"open_issues":2,"closed_issues":1,"state":"open","created_at":"2016-12-15T15:24:24Z","updated_at":"2017-01-19T10:48:23Z","due_on":null,"closed_at":null},"comments":4,"created_at":"2017-01-11T16:04:17Z","updated_at":"2017-01-19T16:10:27Z","closed_at":null,"body":"Based on #401.\r\n\r\n-- Background and Index/README --\r\n**what is it** (example text exists)\r\n**what is it for** (example text exists)\r\nfeatures\r\nwhat is it not\r\nwho are we\r\n**how to contribute**\r\nlicense information\r\n**Accessibility**\r\nscope, goal\r\nvision?\r\n**connectivity**\r\n\r\n-- related projects --\r\nRECAST background information (what is it, what is it for, etc), check for existing documentation with @lukasheinrich\r\n\r\n-- Getting Started --\r\n\r\nauthorization\r\nforms\r\nAPI\r\n\r\n-- Specific HowTo/Examples --\r\n[Use cases: task-oriented walk-throughs, GUI and API]\r\nsee an example analysis record and how it can be used\r\nI am an experimentalalist, how can I use it?\r\nI am a theorist, how can I use it?\r\nWhat information do I need to prepare from my analysis? When should I do it in my analysis (whenever there is an update that you need to save; we version)\r\nI am continuing my colleagues analysis. How can I reuse the info [clone the record, start editing]\r\nHow to use our API with a list of our resources (links/urls they can do requests), descriptions, etc: something like https://developers.facebook.com/docs/graph-api/using-graph-api and also https://about.gitlab.com/handbook/marketing/blog/\r\nprobably separate/highlighted hierarchy level: Guidance on how to publish via shell/API. This needs more thinking and these instructions shall/will be used as specs for the development part also.\r\nAs a database provider within LHC collab, how can I contribute to or profit from CAP\r\n\r\n-- FAQ (but also addressed before) --\r\n[an user-oriented FAQ that contains the TL;DR version of documentation entries, which acts as a navigation interface of the documentation]\r\nWhy do I have to enter information into internal databases AND here? - you dont have to; explain\r\nDo I have to use this rather long form or what other options do I have? - shell, API\r\nI can edit, can my collaborators edit my analysis too? - All your collaboration colleagues can read it, only those you invite specifically (personally or e-group) can edit as well\r\nCan I export the information for reviews/approvals? - yes\r\naddress known concerns\r\n\r\n-- Community --\r\nexplain the community concept, where help is needed\r\ntry to convey the balance of importance when adding/removing details while offering support and guidance on how to get it\r\n\r\n-- Support --\r\nhow to communicate with the user: chat support? Service now? Email?\r\ncollaboration-internal contact persons?\r\n\r\n-- Glossary/Reference --\r\nontology explanation\r\nstatus report, make clear what's there, what is not and what is planned and keep this maintained (also include what is possible)\r\nterminologies\r\nmetadata schema"},"comment":{"url":"https://api.github.com/repos/cernanalysispreservation/analysis-preservation.cern.ch/issues/comments/273818810","html_url":"https://github.com/cernanalysispreservation/analysis-preservation.cern.ch/issues/411#issuecomment-273818810","issue_url":"https://api.github.com/repos/cernanalysispreservation/analysis-preservation.cern.ch/issues/411","id":273818810,"user":{"login":"suenjedt","id":7300319,"avatar_url":"https://avatars.githubusercontent.com/u/7300319?v=3","gravatar_id":"","url":"https://api.github.com/users/suenjedt","html_url":"https://github.com/suenjedt","followers_url":"https://api.github.com/users/suenjedt/followers","following_url":"https://api.github.com/users/suenjedt/following{/other_user}","gists_url":"https://api.github.com/users/suenjedt/gists{/gist_id}","starred_url":"https://api.github.com/users/suenjedt/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/suenjedt/subscriptions","organizations_url":"https://api.github.com/users/suenjedt/orgs","repos_url":"https://api.github.com/users/suenjedt/repos","events_url":"https://api.github.com/users/suenjedt/events{/privacy}","received_events_url":"https://api.github.com/users/suenjedt/received_events","type":"User","site_admin":false},"created_at":"2017-01-19T16:10:27Z","updated_at":"2017-01-19T16:10:27Z","body":"And I would focus on the exp side of the user and leave TH out for now. Too early stage, I think"}}
{"actor":{"display_login":"suenjedt"}}