Commit 8ecd6427 authored by Sergio Merino Hernández's avatar Sergio Merino Hernández Committed by Jose Javier Merchante
Browse files

[docs] Update documentation

This commit will update the documentation of almost every metric and
visualization in order to include information about the new repository
filtering option
parent dceb720b
......@@ -6,5 +6,6 @@ Number of commits by day time in the period defined by the user, ignoring pull/m
index: 'git'
filter: 'files' is not 0
range: from_date < 'grimoire_creation_date' < to_date
filter: 'terms', origin=urls
aggregation: 'terms', script: "doc['grimoire_creation_date'].value.getHourOfDay()"
```
......@@ -6,5 +6,6 @@ Number of commits by weekday in the period defined by the user, ignoring merge r
index: 'git'
filter: 'files' is not 0
range: from_date < 'grimoire_creation_date' < to_date
filter: 'terms', origin=urls
aggregation: 'terms', script: "doc['grimoire_creation_date'].value.dayOfWeek"
```
......@@ -6,6 +6,7 @@ Number of commits by weekday and by day time in the period defined by the user,
index: 'git'
filter: 'files' is not 0
range: from_date < 'grimoire_creation_date' < to_date
filter: 'terms', origin=urls
aggregation: 'terms', field:'commit_date_weekday', size:7, order={'_term': 'asc'}
aggregation: 'terms', field:'commit_date_hour', size:24, order={'_term': 'asc'}
```
......@@ -6,5 +6,6 @@ Evolution of the number of commits in the period defined by the user, ignoring p
index: 'git'
filter: 'files' is not 0
range: from_date < 'grimoire_creation_date' < to_date
filter: 'terms', origin=urls
aggregation: 'date_histogram', field: 'grimoire_creation_date', calendar_interval: '1w'
```
......@@ -9,5 +9,6 @@ Number of commits, ignoring pull/merge request commits.
index: 'git'
unique count: 'hash'
range: from_date < 'grimoire_creation_date' < to_date
filter: 'terms', origin=urls
filter: 'files' is not 0
```
......@@ -8,4 +8,5 @@ Number of files changed
index: 'git'
sum: 'files'
range: from_date < 'grimoire_creation_date' < to_date
filter: 'terms', origin=urls
```
......@@ -6,5 +6,6 @@ Get when the issues are closed by weekday in the period defined by the user.
index: 'all'
filter: pull_request:False or is_gitlab_issue:1
range: from_date < 'closed_at' < to_date
filter: 'terms', origin=urls
aggregation: 'terms', script: "doc['closed_at'].value.dayOfWeek"
```
......@@ -6,6 +6,7 @@ Number of issues closed by weekday and by day time in the period defined by the
index: 'all'
filter: pull_request:False or is_gitlab_issue:1
range: from_date < 'closed_at' < to_date
filter: 'terms', origin=urls
aggregation: 'terms', script: "doc['closed_at'].value.dayOfWeek", size:7, order={'_term': 'asc'}
aggregation: 'terms', script: "doc['closed_at'].value.getHourOfDay()", size:24, order={'_term': 'asc'}
```
......@@ -8,6 +8,7 @@ Number of closed issues in a period of time
```
index: 'all'
range: from_date < 'closed_at' < to_date
filter: 'terms', origin=urls
filter: pull_request:False or is_gitlab_issue:1
filter: 'state' is 'closed'
```
......@@ -8,5 +8,6 @@ Number of created issues in a period of time
```
index: 'all'
range: from_date < 'created_at' < to_date
filter: 'terms', origin=urls
filter: pull_request:False or is_gitlab_issue:1
```
......@@ -6,5 +6,6 @@ Get when the issues are opened by weekday in the period defined by the user.
index: 'all'
filter: pull_request:False or is_gitlab_issue:1
range: from_date < 'created_at' < to_date
filter: 'terms', origin=urls
aggregation: 'terms', script: "doc['created_at'].value.dayOfWeek"
```
......@@ -5,6 +5,7 @@ Open and closed issues by date in the period defined by the user.
```
index: 'all'
filter: pull_request:False or is_gitlab_issue:1
filter: 'terms', origin=urls
<open>
aggregation: 'filter': range(from_date < created_at < to_date)
aggregation: 'date_histogram', field: 'created_at', calendar_interval: '1w'
......
......@@ -8,5 +8,6 @@ Number of open issues on a date.
```
index: 'all'
filter: pull_request:False or is_gitlab_issue:1
filter: 'terms', origin=urls
must : range('created_at' < date) AND (range('closed_at' > date) OR match(state='open'))
```
......@@ -6,6 +6,7 @@ Number of issues opened by weekday and by day time in the period defined by the
index: 'all'
filter: pull_request:False or is_gitlab_issue:1
range: from_date < 'created_at' < to_date
filter: 'terms', origin=urls
aggregation: 'terms', script: "doc['created_at'].value.dayOfWeek", size:7, order={'_term': 'asc'}
aggregation: 'terms', script: "doc['created_at'].value.getHourOfDay()", size:24, order={'_term': 'asc'}
```
......@@ -5,6 +5,7 @@ Number of lines added vs removed in the period defined by the user.
```
index: 'git'
range: from_date < 'grimoire_creation_date' < to_date
filter: 'terms', origin=urls
aggregation: 'date_histogram', field: 'grimoire_creation_date', calendar_interval: '1w'
aggregation: 'sum', script: "doc['lines_removed'].value * -1"
aggregation: 'sum', field: 'lines_added'
......
......@@ -9,5 +9,6 @@ Average lines changed per commit, ignoring pull/merge request commits.
index: 'git'
average: 'lines_changed'
range: from_date < 'grimoire_creation_date' < to_date
filter: 'terms', origin=urls
filter: 'files' is not 0
```
......@@ -8,5 +8,6 @@ Number of closed Pull/Merge Requests in a period of time
```
index: 'all'
range: from_date < 'closed_at' < to_date
filter: 'terms', origin=urls
filter: pull_request:True or merge_request:True
```
......@@ -8,5 +8,6 @@ Number of new Pull/Merge Requests in a period of time
```
index: 'all'
range: from_date < 'created_at' < to_date
filter: 'terms', origin=urls
filter: pull_request:True or merge_request:True
```
......@@ -8,5 +8,6 @@ Number of open issues on a date.
```
index: 'all'
filter: pull_request:True or merge_request:True
filter: 'terms', origin=urls
must : range('created_at' < date) AND (range('closed_at' > date) OR match(state='open'))
```
......@@ -6,5 +6,6 @@ Get when the PRs/MRs are closed by weekday in the period defined by the user.
index: 'all'
filter: pull_request:True or merge_request:True
range: from_date < 'closed_at' < to_date
filter: 'terms', origin=urls
aggregation: 'terms', script: "doc['closed_at'].value.dayOfWeek"
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment