diff --git a/README.md b/README.md index 5b9bf35..d674fbc 100644 --- a/README.md +++ b/README.md @@ -2,28 +2,46 @@ [![Build Status](https://travis-ci.org/tarantool/docbot.svg?branch=master)](https://travis-ci.org/tarantool/docbot) -TarantoolBot automates a process of creating a documentation request after external behaviour is changed. -Documentation bot has its own account on mail.ru and on github.com. Its name is TarantoolBot. -It uses GitHub webhooks to track all new comments on issues. In a comment a one can ask the bot to create a new issue on tarantool/doc, when the original issue will be closed, using the special template. The one must mention the bot, write a title and -description: +TarantoolBot automates a process of creating a documentation request after +external behaviour is changed. Documentation bot has its own account on mail.ru +and on github.com. Its name is TarantoolBot. It uses GitHub webhooks to track +all new comments on issues and commits. In a comment or a commit message a one +can ask the bot to create a new issue on tarantool/doc, when the original issue +will be closed or the commit will be pushed, using the special template. The one +must mention the bot, write a title and description: ``` @TarantoolBot document Title: one-line title Description that can be multiline, contain markup and links. ``` -When the bot sees its mentioning, it checks the comment syntax, and responses with either error -description or with `@: Accept`. When the issue is closed, the bot finds -this comment, extracts the title and description, and creates a new issue on tarantool/doc -with notifying the comment author. Thanks to the bot, now no one must care about creating a doc -issue after push into trunk, changing some external behaviour. +When the bot sees its mentioning, it checks the request syntax and writes result +of request parsing into its web [journal](http://try.tarantool.org:11116). + +If the request had been done via issue comments, then the bot responds with +either error description or with `@: Accept` right into the issue +comments. When the issue is closed, the bot finds this comment, extracts the +title and description, and creates a new issue on tarantool/doc with notifying +the comment author and the original issue/commit. + +When the request is in the commit message, a one should write the request at the +end of the message. Even after `Closes/Fixes etc` GitHub hits. All below the +`@TarantoolBot document` is treated as a request. + +Thanks to the bot, now no one must care about creating a doc issue after push +into trunk, changing some external behaviour. ## Deployment The TarantoolBot deployment is quite simple. -1. Define environment variable GITHUB_TOKEN with the token generated by GitHub for the bot account; +1. Define environment variable GITHUB_TOKEN with the token generated by GitHub + for the bot account; 2. Run `write_credentials.sh`; 3. Install `bottle` and `requests` via `pip`; 4. Run the bot with `python tarantoolbot.py`. -To check that it works try to get `localhost:8888` - it will print the 'hello' message, if all is ok. After this set a GitHub hook in the repository, that you want the bot tracks. The hook must send notifications about new comments in all issues, about closed issues. +To check that it works try to get `localhost:8888` - it will print the +**TarantoolBot Journal** message, if all is ok. After this set a GitHub hook in +the repository, that you want the bot tracks. The hook must send notifications +about new comments in all issues, about closed issues, log all events onto its +webpage.