Skip to content

Commit

Permalink
[doc] Add information about alias to studies doc
Browse files Browse the repository at this point in the history
  • Loading branch information
alpgarcia authored and Alvaro del Castillo committed Apr 13, 2018
1 parent 75195db commit 8e0445b
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions doc/studies.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ data to apply this study on.
### Results
As output you will get an index following our [areas of code index fields convention](https://github.com/chaoss/grimoirelab-elk/blob/master/schema/areas_of_code.csv). This index will be named `git_aoc-enriched`.

Additionally, an alias named `git_areas_of_code` pointing to above's index is created if it doesn't exist.

## Onion Study
This study process information from an enriched index and computes Onion metric on that.

Expand Down Expand Up @@ -108,6 +110,29 @@ This index will be named:
* **GitHub Issues**: `github_issues_onion-enriched`.
* **GitHub Pull Requests**: `github_prs_onion-enriched`.

Finally, an alias named `all_onion` is automatically created, including all of the above mentioned indices:
```
> GET _alias/all_onion
{
"github_issues_onion-enriched": {
"aliases": {
"all_onion": {}
}
},
"git_onion-enriched": {
"aliases": {
"all_onion": {}
}
},
"github_prs_onion-enriched": {
"aliases": {
"all_onion": {}
}
}
}
```


## Running studies from p2o
Running studies from p2o is possible by using `--only-enrich` and `--only-studies` parameters. Other parameters
Expand Down

0 comments on commit 8e0445b

Please sign in to comment.