{"action":"created","issue":{"url":"https://api.github.com/repos/ElektraInitiative/libelektra/issues/1015","repository_url":"https://api.github.com/repos/ElektraInitiative/libelektra","labels_url":"https://api.github.com/repos/ElektraInitiative/libelektra/issues/1015/labels{/name}","comments_url":"https://api.github.com/repos/ElektraInitiative/libelektra/issues/1015/comments","events_url":"https://api.github.com/repos/ElektraInitiative/libelektra/issues/1015/events","html_url":"https://github.com/ElektraInitiative/libelektra/issues/1015","id":182044283,"number":1015,"title":"Website structure","user":{"login":"Namoshek","id":8877609,"avatar_url":"https://avatars.githubusercontent.com/u/8877609?v=3","gravatar_id":"","url":"https://api.github.com/users/Namoshek","html_url":"https://github.com/Namoshek","followers_url":"https://api.github.com/users/Namoshek/followers","following_url":"https://api.github.com/users/Namoshek/following{/other_user}","gists_url":"https://api.github.com/users/Namoshek/gists{/gist_id}","starred_url":"https://api.github.com/users/Namoshek/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Namoshek/subscriptions","organizations_url":"https://api.github.com/users/Namoshek/orgs","repos_url":"https://api.github.com/users/Namoshek/repos","events_url":"https://api.github.com/users/Namoshek/events{/privacy}","received_events_url":"https://api.github.com/users/Namoshek/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/ElektraInitiative/libelektra/labels/proposal","name":"proposal","color":"fef2c0"},{"url":"https://api.github.com/repos/ElektraInitiative/libelektra/labels/work%20in%20progress","name":"work in progress","color":"006b75"}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":9,"created_at":"2016-10-10T15:28:15Z","updated_at":"2016-10-12T15:08:17Z","closed_at":null,"body":"Suggestions on the structure and design of the new website are needed @ElektraInitiative/elektradevelopers.\r\n\r\nCurrently, there is ...\r\n- a main page without any content.\r\n- a documentation page listing all files of the `doc` directory.\r\n- a tutorial page listing all files of the `doc/tutorials` directory.\r\n- a snippet converter.\r\n\r\nIn my opinion, we definitely need some more things like ...\r\n- news page\r\n- changelog\r\n- link to GitHub\r\n- ... but also a more guided documentation section, so more in-depth suggestions on the documentation structure would be appreatiated as well!\r\n\r\nIt would be nice to hear some opinions about what to put where!\r\n\r\nA live demo of the website can always be found at http://namoshek.at:9000."},"comment":{"url":"https://api.github.com/repos/ElektraInitiative/libelektra/issues/comments/253241202","html_url":"https://github.com/ElektraInitiative/libelektra/issues/1015#issuecomment-253241202","issue_url":"https://api.github.com/repos/ElektraInitiative/libelektra/issues/1015","id":253241202,"user":{"login":"markus2330","id":7949075,"avatar_url":"https://avatars.githubusercontent.com/u/7949075?v=3","gravatar_id":"","url":"https://api.github.com/users/markus2330","html_url":"https://github.com/markus2330","followers_url":"https://api.github.com/users/markus2330/followers","following_url":"https://api.github.com/users/markus2330/following{/other_user}","gists_url":"https://api.github.com/users/markus2330/gists{/gist_id}","starred_url":"https://api.github.com/users/markus2330/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/markus2330/subscriptions","organizations_url":"https://api.github.com/users/markus2330/orgs","repos_url":"https://api.github.com/users/markus2330/repos","events_url":"https://api.github.com/users/markus2330/events{/privacy}","received_events_url":"https://api.github.com/users/markus2330/received_events","type":"User","site_admin":false},"created_at":"2016-10-12T15:08:17Z","updated_at":"2016-10-12T15:08:17Z","body":"> The reason I proposed it is not that I need to get the directory structure, [...] I would like us to have a way to define the structure on the website without regard to the structure we have on GitHub.\r\n\r\nYes, that is why I referred to README.md. For example in `src/plugins/README.md` the `- [resolver](resolver/) uses POSIX` already provides the information: `- [Title of page](link to page/) hover text`. Furthermore the links are already in a non-alphabetic order (hopefully useful).\r\n\r\nThe idea is that we use this structure also for the web page.\r\n\r\n> rather logically by steps you need to do until the software runs.\r\n\r\nI fully agree and hope you help in giving the content a better structure!\r\n\r\n> So some sort of manual control is required anyhow.\r\n\r\nYes, also the structure of README.md and of the webpage might sometimes conflict. I fully agree that we need a file for overrides but it should be as maintainable as possible.\r\n\r\n> But of course we can limit this control (and effort) quite a bit by only white- or blacklisting files for example (btw. I'm currently blacklisting cmake, doxygen and other irrelevant files, so this is no bad approach).\r\n\r\nWhitelisting is already done implicitly by README.md, but nevertheless it is no surprise if we still need some exceptions on top of that.\r\n\r\n> We could also write a minimal version of the structure by hand and let a generator make something more useful out of it (i.e. incorporate all of your suggestions with default values, etc). Most parts shouldn't change frequently anyway, but some small things might do.\r\n\r\nYes, this is a good compromise. Can you write it in shell? Ideally it should be executed also on the build server and check consistency of folder structure, README.md and the website overrides.\r\n\r\n> One to get the source tree [...] and another one to get an individual file\r\n\r\nOk, but getting the source tree will not be needed anymore once we have a js with full listings of the content?\r\n\r\n> But what use case do you see here anyway?\r\n\r\nIts only about not being dependent on the github API.\r\n\r\n> Theoretically there could be links to files that are not even meant to be on the website - what to do in this case? Remove the link? Allow the page load?\r\n\r\nDo you mean references to other pages in the js override files? I thought you access content of github files via https://developer.github.com/v3/repos/contents/ so that only files from the repo can be accessed?"}}
{"actor":{"display_login":"markus2330"}}