{"action":"opened","issue":{"url":"https://api.github.com/repos/Tendrl/node_agent/issues/90","repository_url":"https://api.github.com/repos/Tendrl/node_agent","labels_url":"https://api.github.com/repos/Tendrl/node_agent/issues/90/labels{/name}","comments_url":"https://api.github.com/repos/Tendrl/node_agent/issues/90/comments","events_url":"https://api.github.com/repos/Tendrl/node_agent/issues/90/events","html_url":"https://github.com/Tendrl/node_agent/issues/90","id":194319630,"number":90,"title":"[packaging] README file is not in rst file format","user":{"login":"mbukatov","id":4759819,"avatar_url":"https://avatars.githubusercontent.com/u/4759819?v=3","gravatar_id":"","url":"https://api.github.com/users/mbukatov","html_url":"https://github.com/mbukatov","followers_url":"https://api.github.com/users/mbukatov/followers","following_url":"https://api.github.com/users/mbukatov/following{/other_user}","gists_url":"https://api.github.com/users/mbukatov/gists{/gist_id}","starred_url":"https://api.github.com/users/mbukatov/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mbukatov/subscriptions","organizations_url":"https://api.github.com/users/mbukatov/orgs","repos_url":"https://api.github.com/users/mbukatov/repos","events_url":"https://api.github.com/users/mbukatov/events{/privacy}","received_events_url":"https://api.github.com/users/mbukatov/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2016-12-08T12:07:59Z","updated_at":"2016-12-08T12:07:59Z","closed_at":null,"body":"We should convert README file from ascii doc file format into [ReStructuredText](https://en.wikipedia.org/wiki/ReStructuredText). This can be done quite easily with [pandoc](https://apps.fedoraproject.org/packages/pandoc).\r\n\r\n## Reasoning\r\n\r\nIt's a common practice to use [ReStructuredText](https://en.wikipedia.org/wiki/ReStructuredText) file format for [README file in python projects](https://packaging.python.org/distributing/?highlight=readme#readme-rst), which is also commonly used for documentation of python projects (see sphinx). Moreover PyPI can only handle rst file format.\r\n\r\nAlso note that we already have sphinx documentation in tendrl-node-agent project, so having README in ascii doc seems weird and [prevents easy migration of text from README file into sphinx managed documentation](https://github.com/Tendrl/node_agent/issues/89).\r\n"}}
{"actor":{"display_login":"mbukatov"}}