{"action":"opened","issue":{"url":"https://api.github.com/repos/datacleaner/DataCleaner-documentation/issues/1","labels_url":"https://api.github.com/repos/datacleaner/DataCleaner-documentation/issues/1/labels{/name}","comments_url":"https://api.github.com/repos/datacleaner/DataCleaner-documentation/issues/1/comments","events_url":"https://api.github.com/repos/datacleaner/DataCleaner-documentation/issues/1/events","html_url":"https://github.com/datacleaner/DataCleaner-documentation/issues/1","id":112355246,"number":1,"title":"4.5 documentation problems on first readthrough","user":{"login":"LosD","id":1282832,"avatar_url":"https://avatars.githubusercontent.com/u/1282832?v=3","gravatar_id":"","url":"https://api.github.com/users/LosD","html_url":"https://github.com/LosD","followers_url":"https://api.github.com/users/LosD/followers","following_url":"https://api.github.com/users/LosD/following{/other_user}","gists_url":"https://api.github.com/users/LosD/gists{/gist_id}","starred_url":"https://api.github.com/users/LosD/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/LosD/subscriptions","organizations_url":"https://api.github.com/users/LosD/orgs","repos_url":"https://api.github.com/users/LosD/repos","events_url":"https://api.github.com/users/LosD/events{/privacy}","received_events_url":"https://api.github.com/users/LosD/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":0,"created_at":"2015-10-20T12:18:08Z","updated_at":"2015-10-20T12:18:08Z","closed_at":null,"body":"Problems/potential improvements found when reading through documentation for 4.5 (not all are really related to the change in version, though).\r\nLines are in source XML lines. Sections are in source XML ids.\r\n\r\n- [ ] General: We should use captions for images much more (ideally no image should ever be without a caption).\r\n- [ ] Chapter 1.1 line 56: \"a data quality analysis\" -> \"Data quality analysis\"\r\n- [ ] Chapter 1.1 section _what_is_data_profiling_: It would maybe be good to mention the quick analysis gained from a supported version (the \"What can you tell me about my data\" wizard).\r\n- [ ] Chapter 1.1 line 171: Line says \"As of version 3\". That may be a bit uninteresting now we're at 4.5?\r\n- [ ] Chapter 1.2 line 23: Line says that a license file is needed. But that is only true for licensed editions. Maybe add that?\r\n- [ ] Chapter 1.2 section _adding_components_: The _Improve_ super category is mentioned as only containing Transformers, which is not true.\r\n- [ ] Chapter 1.2 line 241: 'but also \"Write\" menu for analyzers that save output to a datastore'. This is a bit simplistic, many non-writers can save to datastore. Maybe change to something like '... for analyzers that only (primarily?) save output to a datastore'.\r\n- [ ] Chapter 1.2 line 285: Wording is a little weird: \"In the bottom part of the canvas, a help message is displayed instructing what needs to be done in current moment to build a valid job.\"\r\n- [ ] Chapter 2.2 line 160: The training tool does not open a new dialog. It's result screen _is_ the \"dialog\".\r\n- [ ] Chapter 2.2 section _DE_suppression_: Rename not really completed, the text still talks about suppression, and the image is using the old name.\r\n- [ ] Chapter 2.2 section _UK_suppression_: Rename not really completed, the text still talks about suppression, and the image is using the old name. Maybe mention that it can use output data streams?\r\n- [ ] Chapter 2.2 section _US_suppression_: Rename not really completed, the text still talks about suppression. Maybe mention that it can use output data streams?\r\n- [ ] Chapter 2.2 section _table_lookup_transformer_: Maybe add that a new datastore can easily be registered with the new :heavy_plus_sign: button and update screenshot.\r\n- [ ] Chapter 2.2 section _national_identifiers_: Screenshot outdated, still contains EAN (even highlighted, to really draw attention to itself :)).\r\n- [ ] Chapter 2.3 section _completeness_analyzer_: Maybe mention that it can use output data streams?\r\n- [ ] Chapter 2.4 section _writers_create_staging_: Maybe add that a new datastore can easily be registered and a new table can easily be generated with the new :heavy_plus_sign: buttons and update screenshot.\r\n- [ ] Chapter 5.1 line 115: We do not provide signed JARs for download, so we should probably not say that we do.\r\n- [ ] Chapter 8.2: Screenshots should probably be upgraded to reflect that AnalyzerBeansConfiguration has been renamed to DataCleanerConfiguration."}}