Add documentation: how to run daily_jenkins_job_report
Change-Id: I169fe612b4e3df531d9dd53c71c0ab3a98ca4c24
Related-prod: PROD-28668
diff --git a/daily_jenkins_job_report/README.md b/daily_jenkins_job_report/README.md
index e69de29..97026ac 100644
--- a/daily_jenkins_job_report/README.md
+++ b/daily_jenkins_job_report/README.md
@@ -0,0 +1,39 @@
+# Generate report of osccore-qa-testing-tools
+
+## Description:
+
+1. Clone repository `osccore-qa-testing-tools`, for example:
+
+ ~~~~
+ git clone http://aminasyan@gerrit.mcp.mirantis.com/a/mcp/osccore-qa-testing-tools
+ ~~~~
+
+2. Install python 3.6 virtualenv:
+
+ ~~~~
+ apt install python3.6-venv
+ ~~~~
+
+3. Create virtualenv and activate this:
+
+ ~~~~
+ virtualenv --python=python3.6 .venv
+ . .venv/bin/activate
+ ~~~~
+
+4. Go to `osccore-qa-testing-tools/daily_jenkins_job_report` and install requirements:
+
+ ~~~~
+ cd osccore-qa-testing-tools/daily_jenkins_job_report
+ pip3 install -r requirements.txt
+ ~~~~
+
+5. Change path of `GENERATED_REPORT` and `REPORT_TEMPLATE` from default to necessary in `osccore-qa-testing-tools/daily_jenkins_job_report/daily_report/config.py`
+
+6. Run `generate_report.py`:
+
+ ~~~~
+ python3 generate_report.py
+ ~~~~
+
+7. After finish script you can find report in path of `GENERATED_REPORT`