{"action":"created","issue":{"url":"https://api.github.com/repos/machinekit/machinekit/issues/924","repository_url":"https://api.github.com/repos/machinekit/machinekit","labels_url":"https://api.github.com/repos/machinekit/machinekit/issues/924/labels{/name}","comments_url":"https://api.github.com/repos/machinekit/machinekit/issues/924/comments","events_url":"https://api.github.com/repos/machinekit/machinekit/issues/924/events","html_url":"https://github.com/machinekit/machinekit/issues/924","id":152372003,"number":924,"title":"Automated build of documentation and website","user":{"login":"luminize","id":2206842,"avatar_url":"https://avatars.githubusercontent.com/u/2206842?v=3","gravatar_id":"","url":"https://api.github.com/users/luminize","html_url":"https://github.com/luminize","followers_url":"https://api.github.com/users/luminize/followers","following_url":"https://api.github.com/users/luminize/following{/other_user}","gists_url":"https://api.github.com/users/luminize/gists{/gist_id}","starred_url":"https://api.github.com/users/luminize/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/luminize/subscriptions","organizations_url":"https://api.github.com/users/luminize/orgs","repos_url":"https://api.github.com/users/luminize/repos","events_url":"https://api.github.com/users/luminize/events{/privacy}","received_events_url":"https://api.github.com/users/luminize/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":338,"created_at":"2016-05-01T19:32:06Z","updated_at":"2016-05-31T09:15:58Z","closed_at":null,"body":"Goals (prioritised from high to loa, mark when done!):\r\n- [x] only work on the content in a minimum way until we get the workflow going, so we can increment and do most of the work on the docs/site thru C4 on machinekit/docs (no hiding [in our cupboard under the stairs](http://i1.wp.com/theverybesttop10.files.wordpress.com/2013/08/the-world_s-top-10-most-amazing-things-to-do-with-under-stairs-spaces-10.jpg?resize=590%2C396) ) **(seriously, this is our nemesis)**\r\n- [x] defragmenting information, bringing all into 1 place\r\n- [x] Improving the readability of the documentation\r\n- [x] lower barrier for improving documentation\r\n- [x] We need to look into the link checker\r\n- [x] remove translations (in machinekit-docs:master to begin with)\r\n- [x] change `:leveloffset:` attributes to incremental ones  as described here https://github.com/machinekit/machinekit/issues/924#issuecomment-218414673\r\n- [x] get better searcheability from search engines\r\n- [x] \"edit-this-page\" for sources coming from different repositories \r\n- [x] when this is all said and done, we can pull the plug on machinekit.github.io (the website repo)\r\n\r\nThe future place to be for info will be machinekit.io\r\n- for project information (current website)\r\n- for documentation\r\n\r\nTo get to that situation, all will be generated by Jekyll from machinekit/machinekit-docs repo\r\n\r\nstep 1: **We aim at the following workflow from the manpages:**\r\n1. a merge on machinekit/machinekit generates asciidoc manpages (static, comp and icomp).\r\n2. asciidoc manpages are brought over to machinekit/machinekit-docs. \r\n3. machinekit/machinekit-docs merge rebuilds the website, and gets served\r\n\r\n(above 3 points see https://github.com/machinekit/machinekit/issues/908)\r\n(We need to find out if every PR to machinekit/machinekit will of that, or only when there are changes in the manpages (static, comp and comp))\r\n\r\nstep 2: **the rest of the workflow should be like so:**\r\n4. machinekit/machinekit-docs holds content for website as well as the documentation.We need to convert the markdown to asciidoc, and put that in machinekit/machinekit-docs\r\n5. commits via PR's from (local) clone\r\n6. machinekit/machinekit-docs PR triggers a site preview on preview.machinekit.io\r\n\r\nstep 3: \r\n7. when OK, merge will trigger final format on machinekit.io\r\n\r\npicture depicts the flow from points 4 - 7\r\n\r\n![jekyll-asciidoc](https://cloud.githubusercontent.com/assets/2206842/14943769/fc85791c-0fe1-11e6-96a1-7dbb4f4dd13e.png)\r\n\r\nsome additions:\r\n\r\n- The build is done with Jekyll from asciidoc sources with `jekyll-asciidoc` plugin\r\n- The plugin uses asciidoc**tor**\r\n- Pages need to have front matter (Jekyll spec), this is a block of 2 3 dashes delimiters. Attributes inside the front matter block are not mandatory:\r\n```\r\n---\r\nlayout: default\r\n---\r\n```\r\n- because of the front matter being not properly displayed when one builds outside of jekyll asciidoc**tor** has a [skip-front-matter attribute](http://asciidoctor.org/docs/user-manual/#front-matter-added-for-static-site-generators) which can be invoked like so: `asciidoctor my-page.asciidoc -a skip-front-matter`\r\n- linking between pages must be done like so: `link:some-directory/target-adoc-file#some-anchor[foo bar]`\r\n\r\n@mhaberler @ArcEye @cdsteinkuehler any additions?\r\n"},"comment":{"url":"https://api.github.com/repos/machinekit/machinekit/issues/comments/222634830","html_url":"https://github.com/machinekit/machinekit/issues/924#issuecomment-222634830","issue_url":"https://api.github.com/repos/machinekit/machinekit/issues/924","id":222634830,"user":{"login":"luminize","id":2206842,"avatar_url":"https://avatars.githubusercontent.com/u/2206842?v=3","gravatar_id":"","url":"https://api.github.com/users/luminize","html_url":"https://github.com/luminize","followers_url":"https://api.github.com/users/luminize/followers","following_url":"https://api.github.com/users/luminize/following{/other_user}","gists_url":"https://api.github.com/users/luminize/gists{/gist_id}","starred_url":"https://api.github.com/users/luminize/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/luminize/subscriptions","organizations_url":"https://api.github.com/users/luminize/orgs","repos_url":"https://api.github.com/users/luminize/repos","events_url":"https://api.github.com/users/luminize/events{/privacy}","received_events_url":"https://api.github.com/users/luminize/received_events","type":"User","site_admin":false},"created_at":"2016-05-31T09:15:58Z","updated_at":"2016-05-31T09:15:58Z","body":"\n> On 31 May 2016, at 11:09, Michael Haberler <notifications@github.com> wrote:\n> \n> yes, the problem was cured by a full rebuild, I think it comes out right now\n> \n> this can be cured be 'Wipe the current workspace' on the website-preview and website-production projects - the next PR or merge respectively will rebuild from scratch, taking about 10min\n> \n\nyes! it comes out correct now. Wunderbar!\nI’ll remember to “Wipe the current workspace’ next time something crazy like this happens.\n\n\n"}}
{"actor":{"display_login":"luminize"}}