[MS2/README] Update README with instructions to generate the report #109
Conversation
aswanipranjal
force-pushed
the
rename-readme
branch
from
1a5a3eb
to
dcd373e
Compare
|
@jgbarah @valeriocos please review? |
manuscripts2/README.md
Outdated
|
|
||
| You can produce the github_issues index using the following command: | ||
| ```bash | ||
| p2o.py --enrich --index github_issues_raw --index-enrich github_issues -e http://localhost:9200 --no_inc --debug --db-host localhost --db-sortinghat <db name> --db-user root github <owner> <repo name> -t <token> |
There was a problem hiding this comment.
It is <db user> instead of "root". Please use \ too split the line so that it feets in about 80 char width.
manuscripts2/README.md
Outdated
|
|
||
| And a github_prs index using this command: | ||
| ```bash | ||
| p2o.py --enrich --index github_prs_raw --index-enrich github_prs -e http://localhost:9200 --no_inc --debug --db-host localhost --db-sortinghat <db name> --db-user root github <owner> <repo name> -t <token> --category pull_request |
There was a problem hiding this comment.
It is <db user> instead of "root". Please use \ too split the line so that it feets in about 80 char width.
manuscripts2/README.md
Outdated
|
|
||
| The git index has no changes and can be produced as follows: | ||
| ```bash | ||
| p2o.py --enrich --index git_raw --index-enrich git -e http://localhost:9200 --no_inc --debug --db-host localhost --db-sortinghat <db name> --db-user root git <repository url> |
There was a problem hiding this comment.
Please use \ too split the line so that it feets in about 80 char width.
manuscripts2/README.md
Outdated
| p2o.py --enrich --index git_raw --index-enrich git -e http://localhost:9200 --no_inc --debug --db-host localhost --db-sortinghat <db name> --db-user root git <repository url> | ||
| ``` | ||
|
|
||
| **NOTE:** If you don't know how or what [Sortinghat](https://github.com/chaoss/grimoirelab-sortinghat) is, please [go through the tutorial](https://grimoirelab.gitbooks.io/tutorial/sortinghat/intro.html). Sortinghat helps us manage the identities of the contributors and manitainers. |
There was a problem hiding this comment.
Add something like "But in this case, you don't really need to know about it if you don't need identity management, which for a first try, likely you don't need".
manuscripts2/README.md
Outdated
| First, run: | ||
|
|
||
| ```bash | ||
| python setup.py install |
manuscripts2/README.md
Outdated
|
|
||
| Now, once the indices mentioned above have been created, you can run the following command to generate the report: | ||
| ```bash | ||
| manuscripts2 -n <name of the report/repository being analysed> -d <name of the directory to store the data in> -s <start date from which the repo has to be analysed> -e <end date upto which the repo is to be analysed> -i <time interval> -u <elasticsearch url where all the indices are being stored> --data-sources <the data sources from which the data is to be gathered from> --indices <custom index names to get the data from> -l <custom logo to be applied to the report> |
There was a problem hiding this comment.
It's better if you use shorter names for the labels, such as <repo_name>. In a following paragraph, you can make it clear that <repo_name> is the "name of the project/repository being analysed" (note project instead of report). But also include an example (for example in this case, "CHAOSS").
There was a problem hiding this comment.
Explain also which data sources are possible (with the correct labels), and how the correspond, one by one, with the indexes.
manuscripts2/README.md
Outdated
| The actual report pdf will be, you guessed it right, a file named `report.pdf`. | ||
|
|
||
| --- | ||
|
|
There was a problem hiding this comment.
Add at least a complete example. You could for example produce a complete example for producing a report of chaoss/grimoirelab-manuscripts and chaoss/grimoirelab-perceval (just to have at least two repositories), from running p2o.py to running manuscripts2.
This code adds instructions on how to create the PDF report using manuscripts2 as well as how the tests can be run.
aswanipranjal
force-pushed
the
rename-readme
branch
from
dcd373e
to
b60c00b
Compare
This PR updates the readme with instructions to create the report.
merge after #108