{"action":"closed","issue":{"url":"https://api.github.com/repos/ckan/ckan/issues/1927","repository_url":"https://api.github.com/repos/ckan/ckan","labels_url":"https://api.github.com/repos/ckan/ckan/issues/1927/labels{/name}","comments_url":"https://api.github.com/repos/ckan/ckan/issues/1927/comments","events_url":"https://api.github.com/repos/ckan/ckan/issues/1927/events","html_url":"https://github.com/ckan/ckan/issues/1927","id":42716134,"number":1927,"title":"Documentation for ckan.site_about config option is misleading","user":{"login":"cygri","id":92551,"avatar_url":"https://avatars.githubusercontent.com/u/92551?v=3","gravatar_id":"","url":"https://api.github.com/users/cygri","html_url":"https://github.com/cygri","followers_url":"https://api.github.com/users/cygri/followers","following_url":"https://api.github.com/users/cygri/following{/other_user}","gists_url":"https://api.github.com/users/cygri/gists{/gist_id}","starred_url":"https://api.github.com/users/cygri/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cygri/subscriptions","organizations_url":"https://api.github.com/users/cygri/orgs","repos_url":"https://api.github.com/users/cygri/repos","events_url":"https://api.github.com/users/cygri/events{/privacy}","received_events_url":"https://api.github.com/users/cygri/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/ckan/ckan/labels/Good%20for%20Contribution","name":"Good for Contribution","color":"009800"}],"state":"closed","locked":false,"assignee":{"login":"joetsoi","id":241130,"avatar_url":"https://avatars.githubusercontent.com/u/241130?v=3","gravatar_id":"","url":"https://api.github.com/users/joetsoi","html_url":"https://github.com/joetsoi","followers_url":"https://api.github.com/users/joetsoi/followers","following_url":"https://api.github.com/users/joetsoi/following{/other_user}","gists_url":"https://api.github.com/users/joetsoi/gists{/gist_id}","starred_url":"https://api.github.com/users/joetsoi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/joetsoi/subscriptions","organizations_url":"https://api.github.com/users/joetsoi/orgs","repos_url":"https://api.github.com/users/joetsoi/repos","events_url":"https://api.github.com/users/joetsoi/events{/privacy}","received_events_url":"https://api.github.com/users/joetsoi/received_events","type":"User","site_admin":false},"milestone":null,"comments":1,"created_at":"2014-09-14T08:43:45Z","updated_at":"2016-02-12T10:31:33Z","closed_at":"2016-02-12T10:31:33Z","body":"Problems with the documentation for `ckan.site_about`:\r\n\r\n1. It turns out you can't have empty lines in ckan.ini configuration options. Empty lines in multi-line ini values [will be swallowed by the config file parser](http://python.6.x6.nabble.com/ConfigParser-and-newlines-td1565679.html). There should be a warning about this.\r\n2. The documentation shows a default value for this option, but it's incorrect. The default value of the config option is (none). The value shown is the *HTML* snippet that CKAN uses if the option is *not set*. Its presence here suggests that HTML markup such as `<p>` can be used in CKAN's Markdown syntax to work around the problem above, but that doesn't work either because such HTML markup is stripped. The docs should state that the default is (none), and the misleading HTML snippet should be removed.\r\n\r\nI note that in practice, these issues make the `ckan.site_about` option is unusable from the ini file. The documentation should IMO discourage users from trying to use this option in the ini file, and instead refer them to other ways of setting the about page contents, in particular through the Administration config form."}}