[doc] Update prosoul-grimoirelab.md #216
Conversation
vchrombie
force-pushed
the
documentation
branch
2 times, most recently
from
629a006
to
434e8e3
Compare
vchrombie
changed the title
vchrombie
force-pushed
the
documentation
branch
from
434e8e3
to
1bdd385
Compare
There was a problem hiding this comment.
I have completed most of the work.
I have added an example quality model that is being used in the documentation. I am planning to make the tutorial based on the documentation (examples will be the same) so that it will be easy to follow.
I have two comments, please check them and let me know what do you think about them.
Please review it when you are free and let me know if there are any suggestions/improvements in the documentation.
| ``` | ||
| POST /_aliases | ||
| { | ||
| "actions": [ | ||
| { | ||
| "add": { | ||
| "indices": [ | ||
| "grimoirelab_gitqm_enriched", | ||
| "grimoirelab_githubqm_issues_enriched" | ||
| ], | ||
| "alias": "all_qm_data" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Would it be good if we can automate the alias adding?
I understand that we can add an alias to the enriched indices using sirmordred by having an entry in the aliases.json.
Ref: chaoss/grimoirelab-sirmordred#486
So, we can add a common alias (all_qm_data) to all the enriched QM enriched indices.
The only disadvantage I see is all the enriched indices will be a part of the assessment.
If we enrich githubqm:pull but we don't want it in the assessment, then we have to manually remove the alias.
| Setup alias for all the qm results indices. | ||
| ``` | ||
| POST /_aliases | ||
| { | ||
| "actions": [ | ||
| { | ||
| "add": { | ||
| "indices": [ | ||
| "all_qm_data_null_scores", | ||
| "all_qm_data_null_scores_by_quarters", | ||
| "all_qm_data_scores", | ||
| "all_qm_data_scores_by_quarters" | ||
| ], | ||
| "alias": "all_qm_data_results" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Would it be good if we can automate the alias adding?
I understand that we can add an alias to the prosoul indices. prosoul_assess.py#L754
So, we can add a common alias (all_results_alias) to all the prosoul indices.
all_results_alias = es_index + "_results"
# all_results_alias = all_qm_data_results
es_conn.indices.update_aliases({
"actions": [
{"add": {"index": null_scores_index, "alias": all_scores_alias}},
+ {"add": {"index": null_scores_index, "alias": all_results_alias}},
{"add": {"index": scores_index, "alias": all_scores_alias}},
+ {"add": {"index": scores_index, "alias": all_results_alias}},
{"add": {"index": null_scores_quarters_index, "alias": all_scores_quarters_alias}},
+ {"add": {"index": null_scores_quarters_index, "alias": all_results_alias}},
{"add": {"index": scores_quarters_index, "alias": all_scores_quarters_alias}},
+ {"add": {"index": scores_quarters_index, "alias": all_results_alias}},
]
})
WDYT?
vchrombie
force-pushed
the
documentation
branch
from
1bdd385
to
efd1942
Compare
vchrombie
changed the title
| @@ -1,39 +1,144 @@ | |||
| # Using prosoul with GrimoireLab | |||
| # Using Prosoul with GrimoireLab | |||
|
|
|||
There was a problem hiding this comment.
We can add the prosoul with the grimoirelab image here, once the PR #213 is good to go.
WDYT?
This commit updates the documentation with the workflow of using prosoul along with grimoirelab. A sample QM is also added to the data folder. Signed-off-by: Venu Vardhan Reddy Tekula <[email protected]>
vchrombie
force-pushed
the
documentation
branch
from
6b12ca8
to
c31f39e
Compare
This PR aims for updating the documentation and workflow of how to use prosoul with grimoirelab.
Open for suggestions/improvements. 🙂
There is a little work pending/incomplete. I will complete it soon.