search

chaoss / grimoirelab-elk

GNU General Public License v3.0
59 stars 121 forks source link

Tautology in Elk's description #972

Closed stevenkolawole closed 3 years ago

stevenkolawole commented 3 years ago

I was going through the source code while reading the README.md alongside when I stumbled upon this;

Bugzilla: each document corresponds to a single issue. Bugzillarest: each document corresponds to a single issue.

https://github.com/chaoss/grimoirelab-elk/blob/master/README.md#enriched-data.

Both Bugzilla and Bugzillarest documents refer to the same definition.

Is there a mixup somewhere or do they genuinely mean the same thing? If they both mean the same thing, wouldn't one of them suffice, instead of having two documents with the same meaning?

cc: @vchrombie

sduenas commented 3 years ago

Maybe we can reword that. Bugzilla and Bugzillarest refer to the backends/APIs used to retrieve that data. Both were obtained from bugzilla datasource but the structure of data - not the content - is different.

Data from Bugzilla was obtained using CGIs calls and returns data in XML format. Later, it's converted to JSON. On the other hand. Bugzillarest data is obtained using Bugzilla's REST API and the data is stored in JSON format.

stevenkolawole commented 3 years ago

Alright. It is much clearer now. Thank you. 😄

The rewording, is it something I could do?

sduenas commented 3 years ago

Sure! Go for it.