{"action":"created","issue":{"url":"https://api.github.com/repos/cksource/docs-builder/issues/6","repository_url":"https://api.github.com/repos/cksource/docs-builder","labels_url":"https://api.github.com/repos/cksource/docs-builder/issues/6/labels{/name}","comments_url":"https://api.github.com/repos/cksource/docs-builder/issues/6/comments","events_url":"https://api.github.com/repos/cksource/docs-builder/issues/6/events","html_url":"https://github.com/cksource/docs-builder/pull/6","id":175068485,"number":6,"title":"Initial version","user":{"login":"pomek","id":2270764,"avatar_url":"https://avatars.githubusercontent.com/u/2270764?v=3","gravatar_id":"","url":"https://api.github.com/users/pomek","html_url":"https://github.com/pomek","followers_url":"https://api.github.com/users/pomek/followers","following_url":"https://api.github.com/users/pomek/following{/other_user}","gists_url":"https://api.github.com/users/pomek/gists{/gist_id}","starred_url":"https://api.github.com/users/pomek/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pomek/subscriptions","organizations_url":"https://api.github.com/users/pomek/orgs","repos_url":"https://api.github.com/users/pomek/repos","events_url":"https://api.github.com/users/pomek/events{/privacy}","received_events_url":"https://api.github.com/users/pomek/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":{"login":"Reinmar","id":156149,"avatar_url":"https://avatars.githubusercontent.com/u/156149?v=3","gravatar_id":"","url":"https://api.github.com/users/Reinmar","html_url":"https://github.com/Reinmar","followers_url":"https://api.github.com/users/Reinmar/followers","following_url":"https://api.github.com/users/Reinmar/following{/other_user}","gists_url":"https://api.github.com/users/Reinmar/gists{/gist_id}","starred_url":"https://api.github.com/users/Reinmar/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Reinmar/subscriptions","organizations_url":"https://api.github.com/users/Reinmar/orgs","repos_url":"https://api.github.com/users/Reinmar/repos","events_url":"https://api.github.com/users/Reinmar/events{/privacy}","received_events_url":"https://api.github.com/users/Reinmar/received_events","type":"User","site_admin":false},"assignees":[{"login":"Reinmar","id":156149,"avatar_url":"https://avatars.githubusercontent.com/u/156149?v=3","gravatar_id":"","url":"https://api.github.com/users/Reinmar","html_url":"https://github.com/Reinmar","followers_url":"https://api.github.com/users/Reinmar/followers","following_url":"https://api.github.com/users/Reinmar/following{/other_user}","gists_url":"https://api.github.com/users/Reinmar/gists{/gist_id}","starred_url":"https://api.github.com/users/Reinmar/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Reinmar/subscriptions","organizations_url":"https://api.github.com/users/Reinmar/orgs","repos_url":"https://api.github.com/users/Reinmar/repos","events_url":"https://api.github.com/users/Reinmar/events{/privacy}","received_events_url":"https://api.github.com/users/Reinmar/received_events","type":"User","site_admin":false}],"milestone":null,"comments":1,"created_at":"2016-09-05T13:09:29Z","updated_at":"2016-09-05T13:36:08Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/cksource/docs-builder/pulls/6","html_url":"https://github.com/cksource/docs-builder/pull/6","diff_url":"https://github.com/cksource/docs-builder/pull/6.diff","patch_url":"https://github.com/cksource/docs-builder/pull/6.patch"},"body":"Fixes: #1, #2, #3, #4 \r\n\r\nIn order to verify all the changes, you have to change few branches:\r\n\r\n- [ckeditor5#**t/243**](https://github.com/ckeditor/ckeditor5/tree/t/243) - contains a config for integration,\r\n- [ckeditor5-dev-compiler#**docs**](https://github.com/ckeditor/ckeditor5-dev-compiler/tree/docs) - removes the old `docs` task,\r\n- [ckeditor5-dev-docs#**t/1**](https://github.com/ckeditor/ckeditor5-dev-docs/tree/t/1) - needs `docs-builder` as a dependency. It contains an integration between CKEditor and Documentation Builder,\r\n\r\nAt this moment, **all the modules aren't covered by tests**. This version is more like the prototype than a production code. I believe we will introduce a lot of fixes which improve this tool.\r\n\r\n### How does it work?\r\n\r\nThe following tasks are execute one after the other:\r\n\r\n1. **Compile CSS / SASS / SCSS files** - compiles the main stylesheet,\r\n1. **Compile JS files (using Rollup)** - compiles all scripts files,\r\n1. **Compile Markdown files to HTML** - parses source files to `HTML` file,\r\n1. **Build samples** - merges sample files into one (`*.JS`, `*.HTML` and `*.MD` files)\r\n1. **Save static files (CSS and JS)** - saves the compiled files in storage,\r\n1. **Build side navigation** - parses the compiled sources in order to build a navigation tree,\r\n1. **Prepare breadcrumbs menu for all files** - parse each file in order to build a breadcrumb menu,\r\n1. **Save HTML files** - saves the compiled sources in storage,\r\n1. **Copy static files (like fonts, images, etc)** - copies all the static files (to destination directory),\r\n1. **Create the main page for particular section** - based on sources, makes the main page for particular section (looks like a site map),\r\n1. **Create index page (available under `/index.html`)** - creates a main page for documentation,\r\n1. **Build API documentation (based on jsDoc)** - runs jsDoc in order to build a documentation for source code,\r\n1. **Create ZIP archive (it also works offline)** - packs all the files into one archive. Documentation can be read in offline mode.\r\n\r\nStill, a lot of things are missing but we can merge it to the main branch and start using it. When we start to use this tool, we will know what can be improved. At this moment, we don't know. "},"comment":{"url":"https://api.github.com/repos/cksource/docs-builder/issues/comments/244748647","html_url":"https://github.com/cksource/docs-builder/pull/6#issuecomment-244748647","issue_url":"https://api.github.com/repos/cksource/docs-builder/issues/6","id":244748647,"user":{"login":"pomek","id":2270764,"avatar_url":"https://avatars.githubusercontent.com/u/2270764?v=3","gravatar_id":"","url":"https://api.github.com/users/pomek","html_url":"https://github.com/pomek","followers_url":"https://api.github.com/users/pomek/followers","following_url":"https://api.github.com/users/pomek/following{/other_user}","gists_url":"https://api.github.com/users/pomek/gists{/gist_id}","starred_url":"https://api.github.com/users/pomek/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pomek/subscriptions","organizations_url":"https://api.github.com/users/pomek/orgs","repos_url":"https://api.github.com/users/pomek/repos","events_url":"https://api.github.com/users/pomek/events{/privacy}","received_events_url":"https://api.github.com/users/pomek/received_events","type":"User","site_admin":false},"created_at":"2016-09-05T13:36:08Z","updated_at":"2016-09-05T13:36:08Z","body":"I forgot to mention about changes in `ckeditor5-dev-docs`. I've updated my first comment."}}
{"actor":{"display_login":"pomek"}}