{"action":"created","issue":{"url":"https://api.github.com/repos/mlr-org/mlr/issues/2123","repository_url":"https://api.github.com/repos/mlr-org/mlr","labels_url":"https://api.github.com/repos/mlr-org/mlr/issues/2123/labels{/name}","comments_url":"https://api.github.com/repos/mlr-org/mlr/issues/2123/comments","events_url":"https://api.github.com/repos/mlr-org/mlr/issues/2123/events","html_url":"https://github.com/mlr-org/mlr/pull/2123","id":284474359,"number":2123,"title":"Move from mkdocs to pkgdown and integrate mlr-tutorial into mlr","user":{"login":"pat-s","id":8430564,"avatar_url":"https://avatars3.githubusercontent.com/u/8430564?v=4","gravatar_id":"","url":"https://api.github.com/users/pat-s","html_url":"https://github.com/pat-s","followers_url":"https://api.github.com/users/pat-s/followers","following_url":"https://api.github.com/users/pat-s/following{/other_user}","gists_url":"https://api.github.com/users/pat-s/gists{/gist_id}","starred_url":"https://api.github.com/users/pat-s/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pat-s/subscriptions","organizations_url":"https://api.github.com/users/pat-s/orgs","repos_url":"https://api.github.com/users/pat-s/repos","events_url":"https://api.github.com/users/pat-s/events{/privacy}","received_events_url":"https://api.github.com/users/pat-s/received_events","type":"User","site_admin":false},"labels":[{"id":301971784,"url":"https://api.github.com/repos/mlr-org/mlr/labels/pr-please%20review","name":"pr-please review","color":"d4c5f9","default":false},{"id":54191380,"url":"https://api.github.com/repos/mlr-org/mlr/labels/type-enhancement","name":"type-enhancement","color":"84b6eb","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":30,"created_at":"2017-12-25T23:55:29Z","updated_at":"2018-02-14T15:32:54Z","closed_at":null,"author_association":"CONTRIBUTOR","pull_request":{"url":"https://api.github.com/repos/mlr-org/mlr/pulls/2123","html_url":"https://github.com/mlr-org/mlr/pull/2123","diff_url":"https://github.com/mlr-org/mlr/pull/2123.diff","patch_url":"https://github.com/mlr-org/mlr/pull/2123.patch"},"body":"Hi guys,\r\n\r\nsorry for the mass of modified files but I see no option how I could do this in another way?\r\n\r\nLooking forward hearing your opinion on this PR :smiley: \r\n\r\nFor Travis, please refer to the [recent builds of my fork](https://travis-ci.org/pat-s/mlr) and not the PR \r\none.\r\n\r\n# Before merging\r\n\r\n\r\n- [ ]  Update the .travis.yml. Currently its tailored to my fork.\r\n\r\n# Features\r\n\r\n* Live preview of [mlr-tutorial (devel)](https://pat-s.github.io/mlr/) (will of course be changed from `pat-s` url to `mlr-org` when being merged)\r\n* Integration of [mlr-tutorial (release)](https://pat-s.github.io/mlr/articles/tutorial/release/index.html) with all internal links working. I needed to manually edit most of the `release` files to get the internal links working while maintaining the same url structure as `devel`. However, this should have been a one-time thing and not needed to be done again after the next CRAN release.\r\n* Linking to `pkgdown` implementations of other packages\r\n* Fully R based\r\n* Integrated NEWS menu in menu bar\r\n* Cheatsheet linked on main page\r\n* Links to slack, stackoverflow, github and blog in menu bar\r\n* Better and cleaner look\r\n* Easier build process\r\n* Orcid ID linked next to author name in main page\r\n* Search bar (right now a bit buggy as search need to be entered twice)\r\n* Easier travis build process\r\n* Build of new PDF version based on `bookdown::pdf_document2()` [release](https://github.com/pat-s/mlr/blob/gh-pages/articles/tutorial/release/mlr-tutorial.pdf), [devel](https://github.com/pat-s/mlr/tree/master/vignettes/tutorial/devel/pdf/mlr-tutorial.pdf)\r\n* Uses the new logo that was proposed some months ago in the Slack group\r\n\r\n# Miscellaneous\r\n* Cleaned up `mlr-tutorial` sources (new line for every new sentence, consistent new line spacing, consistent space around code-chunks)\r\n* Added [mlr-contribution guide](https://pat-s.github.io/mlr/#mlr-tutorial) to `README.md`\r\n* Older `mlr-tutorial` versions starting from =< 2.10 are placed in `vignettes/tutorial/old/` and are still accessible but only file-by-file, i.e. without working internal linking, e.g. [Bagging section from 2.10](https://pat-s.github.io/mlr/articles/tutorial/old/2.10/html/bagging/index.html)\r\n\r\n# Implementation \r\n* Site is served via `gh-pages` branch and deployed via `ropenscilabs/tic`. \r\n* As `pkgdown` takes a lot of information from the DESCRIPTION and other informative files of the main repo, there is no way to put all this into a separate repo as it was before with `mlr-tutorial`\r\n* Building is done with a forked version of `pkgdown` in which I implemented some open PR's from the main repo (Orcid ID, ability to exclude certain files, search bar). I will keep the fork up-to-date with master until everything is implemented.\r\n* Currently it is necessary to specify a output format dependent insertion of figures as the scaling for html and pdf output does not align nicely with the same settings. However, we only have 3 external images right now in all ~300 pages of `mlr-tutorial` so this should not be a problem. See [this section](https://github.com/pat-s/mlr/blob/master/vignettes/tutorial/devel/handling_of_spatial_data.Rmd) for an example.\r\n* [The Travis builds](https://travis-ci.org/pat-s/mlr/builds) are currently running on a matrix to separate html and pdf version but can of course be combined. Due to the limited build time in my fork implementation this was not possible. \r\n* For merge, the repo owner (I assume @berndbischl?) has to set the Github pages branch under `Settings >> Github pages` so that the site deployment can work\r\n* For the handling of issues and PR, I propose to add labels with `tutorial` or `mlr-tutorial`. There not that many issues and PRs in `mlr-tutorial` compared to `mlr` so I think this is handable.\r\n\r\n# To Do\r\n\r\n- [x] Figures are not displayed anymore after applying \"display code in boxes\" -> Using rawgithubuser paths as that works for all instances (docs, pdf, vignettes dirs)\r\n\r\n- [x] PDF headers are misaligned due to the need of the \"title\" field in the .Rmd files. I need to find a way to decrease all headers of the child documents in the PDF wrapper `_pdf_wrapper.Rmd` by one level -> fixed by inserting topic headers (h2) manually in _pdf_wrapper.Rmd"},"comment":{"url":"https://api.github.com/repos/mlr-org/mlr/issues/comments/365643736","html_url":"https://github.com/mlr-org/mlr/pull/2123#issuecomment-365643736","issue_url":"https://api.github.com/repos/mlr-org/mlr/issues/2123","id":365643736,"user":{"login":"pat-s","id":8430564,"avatar_url":"https://avatars3.githubusercontent.com/u/8430564?v=4","gravatar_id":"","url":"https://api.github.com/users/pat-s","html_url":"https://github.com/pat-s","followers_url":"https://api.github.com/users/pat-s/followers","following_url":"https://api.github.com/users/pat-s/following{/other_user}","gists_url":"https://api.github.com/users/pat-s/gists{/gist_id}","starred_url":"https://api.github.com/users/pat-s/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pat-s/subscriptions","organizations_url":"https://api.github.com/users/pat-s/orgs","repos_url":"https://api.github.com/users/pat-s/repos","events_url":"https://api.github.com/users/pat-s/events{/privacy}","received_events_url":"https://api.github.com/users/pat-s/received_events","type":"User","site_admin":false},"created_at":"2018-02-14T15:32:54Z","updated_at":"2018-02-14T15:32:54Z","author_association":"CONTRIBUTOR","body":"@jakob-r  @larskotthoff \r\n\r\nIs there anything still missing / open to discuss before it would be ready to merge?\r\n\r\nSmall adjustments (themeing, logo changes) could of course also be applied after merge. \r\nImo its stable and is at the most recent state of `mlr-tutorial`, so we could implement all further additions here after merge. \r\nThis would prevent us from having to maintain two repos at the same time. \r\nI will of course also maintain it and push it further / clean up issues, so my work is not done after the merge ;)"}}
{"actor":{"display_login":"pat-s"}}