Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update optional/suggested keywords as comments #582

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update optional/suggested keywords as comments #582

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
142 changes: 71 additions & 71 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,9 +229,9 @@ Bugs from Bugzilla
[bugzilla]
raw_index = bugzilla_raw
enriched_index = bugzilla_enriched
backend-user = yyyy (optional)
backend-password = xxxx (optional)
no-archive = true (suggested)
backend-user = yyyy # (optional)
backend-password = xxxx # (optional)
no-archive = true # (suggested)
```
#### bugzillarest [↑](#supported-data-sources-)
Bugs from Bugzilla server (>=5.0) using its REST API
Expand All @@ -252,9 +252,9 @@ Bugs from Bugzilla server (>=5.0) using its REST API
[bugzillarest]
raw_index = bugzillarest_raw
enriched_index = bugzillarest_enriched
backend-user = yyyy (optional)
backend-password = xxxx (optional)
no-archive = true (suggested)
backend-user = yyyy # (optional)
backend-password = xxxx # (optional)
no-archive = true # (suggested)
```
#### cocom [↑](#supported-data-sources-)
Code complexity integration.
Expand Down Expand Up @@ -321,7 +321,7 @@ contents from Confluence
[confluence]
raw_index = confluence_raw
enriched_index = confluence_enriched
no-archive = true (suggested)
no-archive = true # (suggested)
```
#### crates [↑](#supported-data-sources-)
packages from Crates.io
Expand Down Expand Up @@ -359,7 +359,7 @@ Topics from Discourse
[discourse]
raw_index = discourse_raw
enriched_index = discourse_enriched
no-archive = true (suggested)
no-archive = true # (suggested)
```
#### dockerhub [↑](#supported-data-sources-)
Repositories info from DockerHub
Expand All @@ -378,7 +378,7 @@ Repositories info from DockerHub
[dockerhub]
raw_index = dockerhub_raw
enriched_index = dockerhub_enriched
no-archive = true (suggested)
no-archive = true # (suggested)
```
#### dockerdeps [↑](#supported-data-sources-)
Dependencies extracted from Dockerfiles. Requires https://github.com/crossminer/crossJadolint
Expand Down Expand Up @@ -439,7 +439,7 @@ Tests from functest
[functest]
raw_index = functest_raw
enriched_index = functest_enriched
no-archive = true (suggested)
no-archive = true # (suggested)
```
#### gerrit [↑](#supported-data-sources-)
Reviews from Gerrit
Expand All @@ -462,18 +462,18 @@ You have to add your public key in the gerrit server.
raw_index = gerrit_raw
enriched_index = gerrit_enriched
user = xxxx
no-archive = true (suggested)
blacklist-ids = [] (optional)
max-reviews = 500 (optional)
studies = [enrich_demography:gerrit, enrich_onion:gerrit, enrich_demography_contribution:gerrit] (optional)
no-archive = true # (suggested)
blacklist-ids = [] # (optional)
max-reviews = 500 # (optional)
studies = [enrich_demography:gerrit, enrich_onion:gerrit, enrich_demography_contribution:gerrit] # (optional)

[enrich_demography:gerrit] (optional)
[enrich_demography:gerrit] # (optional)

[enrich_onion:gerrit] (optional)
[enrich_onion:gerrit] # (optional)
in_index = gerrit_enriched
out_index = gerrit-onion_enriched

[enrich_demography_contribution:gerrit] (optional)
[enrich_demography_contribution:gerrit] # (optional)
date_field = grimoire_creation_date
author_field = author_uuid
```
Expand All @@ -498,19 +498,19 @@ Commits from Git
[git]
raw_index = git_raw
enriched_index = git_enriched
latest-items = true (suggested)
studies = [enrich_demography:git, enrich_git_branches:git, enrich_areas_of_code:git, enrich_onion:git, enrich_extra_data:git] (optional)
latest-items = true # (suggested)
studies = [enrich_demography:git, enrich_git_branches:git, enrich_areas_of_code:git, enrich_onion:git, enrich_extra_data:git] # (optional)

[enrich_demography:git] (optional)
[enrich_demography:git] # (optional)

[enrich_git_branches:git] (optional)
run_month_days = [1, 23] (optional)
[enrich_git_branches:git] # (optional)
run_month_days = [1, 23] # (optional)

[enrich_areas_of_code:git] (optional)
[enrich_areas_of_code:git] # (optional)
in_index = git_raw
out_index = git-aoc_enriched

[enrich_onion:git] (optional)
[enrich_onion:git] # (optional)
in_index = git_enriched
out_index = git-onion_enriched

Expand Down Expand Up @@ -543,25 +543,25 @@ enriched_index = github_enriched
api-token = xxxx
category = issue
sleep-for-rate = true
no-archive = true (suggested)
no-archive = true # (suggested)
studies = [enrich_onion:github,
enrich_geolocation:user,
enrich_geolocation:assignee,
enrich_extra_data:github,
enrich_backlog_analysis,
enrich_demography:github] (optional)
enrich_demography:github] # (optional)

[enrich_onion:github] (optional)
[enrich_onion:github] # (optional)
in_index_iss = github_issues_onion-src
in_index_prs = github_prs_onion-src
out_index_iss = github-issues-onion_enriched
out_index_prs = github-prs-onion_enriched

[enrich_geolocation:user] (optional)
[enrich_geolocation:user] # (optional)
location_field = user_location
geolocation_field = user_geolocation

[enrich_geolocation:assignee] (optional)
[enrich_geolocation:assignee] # (optional)
location_field = assignee_location
geolocation_field = assignee_geolocation

Expand Down Expand Up @@ -596,11 +596,11 @@ enriched_index = github-pull_enriched
api-token = xxxx
category = pull_request
sleep-for-rate = true
no-archive = true (suggested)
no-archive = true # (suggested)
studies = [enrich_geolocation:user,
enrich_geolocation:assignee,
enrich_extra_data:github,
enrich_demography:github] (optional)
enrich_demography:github] # (optional)

[enrich_geolocation:user]
location_field = user_location
Expand Down Expand Up @@ -637,7 +637,7 @@ enriched_index = github-repo_enriched
api-token = xxxx
category = repository
sleep-for-rate = true
no-archive = true (suggested)
no-archive = true # (suggested)
studies = [enrich_extra_data:github, enrich_demography:github]

[enrich_extra_data:github]
Expand Down Expand Up @@ -671,9 +671,9 @@ raw_index = github_event_raw
enriched_index = github_event_enriched
api-token = xxxxx
sleep-for-rate = true
sleep-time = "300" (optional)
no-archive = true (suggested)
studies = [enrich_duration_analysis:kanban, enrich_reference_analysis] (optional)
sleep-time = "300" # (optional)
no-archive = true # (suggested)
studies = [enrich_duration_analysis:kanban, enrich_reference_analysis] # (optional)

[enrich_duration_analysis:kanban]
start_event_type = MovedColumnsInProjectEvent
Expand All @@ -687,7 +687,7 @@ target_attr = label
fltr_attr = label
fltr_event_types = [LabeledEvent]

[enrich_reference_analysis] (optional)
[enrich_reference_analysis] # (optional)
```

#### github2 [↑](#supported-data-sources-)
Expand Down Expand Up @@ -716,14 +716,14 @@ raw_index = github2-issues_raw
enriched_index = github2-issues_enriched
sleep-for-rate = true
category = issue
no-archive = true (suggested)
studies = [enrich_geolocation:user, enrich_geolocation:assignee, enrich_extra_data:github2, enrich_feelings] (optional)
no-archive = true # (suggested)
studies = [enrich_geolocation:user, enrich_geolocation:assignee, enrich_extra_data:github2, enrich_feelings] # (optional)

[enrich_geolocation:user] (optional)
[enrich_geolocation:user] # (optional)
location_field = user_location
geolocation_field = user_geolocation

[enrich_geolocation:assignee] (optional)
[enrich_geolocation:assignee] # (optional)
location_field = assignee_location
geolocation_field = assignee_geolocation

Expand Down Expand Up @@ -754,14 +754,14 @@ raw_index = github2-pull_raw
enriched_index = github2-pull_enriched
sleep-for-rate = true
category = pull_request
no-archive = true (suggested)
studies = [enrich_geolocation:user, enrich_geolocation:assignee, enrich_extra_data:git, enrich_feelings] (optional)
no-archive = true # (suggested)
studies = [enrich_geolocation:user, enrich_geolocation:assignee, enrich_extra_data:git, enrich_feelings] # (optional)

[enrich_geolocation:user] (optional)
[enrich_geolocation:user] # (optional)
location_field = user_location
geolocation_field = user_geolocation

[enrich_geolocation:assignee] (optional)
[enrich_geolocation:assignee] # (optional)
location_field = assignee_location
geolocation_field = assignee_geolocation

Expand Down Expand Up @@ -806,10 +806,10 @@ raw_index = gitlab-issues_raw
enriched_index = gitlab-issues_enriched
api-token = xxxx
sleep-for-rate = true
no-archive = true (suggested)
studies = [enrich_onion:gitlab-issue] (optional)
no-archive = true # (suggested)
studies = [enrich_onion:gitlab-issue] # (optional)

[enrich_onion:gitlab-issue] (optional)
[enrich_onion:gitlab-issue] # (optional)
in_index = gitlab-issues_enriched
out_index = gitlab-issues-onion_enriched
data_source = gitlab-issues
Expand Down Expand Up @@ -837,10 +837,10 @@ raw_index = gitlab-mrs_raw
enriched_index = gitlab-mrs_enriched
api-token = xxxx
sleep-for-rate = true
no-archive = true (suggested)
studies = [enrich_onion:gitlab-merge] (optional)
no-archive = true # (suggested)
studies = [enrich_onion:gitlab-merge] # (optional)

[enrich_onion:gitlab-merge] (optional)
[enrich_onion:gitlab-merge] # (optional)
in_index = gitlab-mrs_enriched
out_index = gitlab-mrs-onion_enriched
data_source = gitlab-merges
Expand Down Expand Up @@ -868,8 +868,8 @@ raw_index = gitter_raw
enriched_index = gitter_enriched_raw
api-token = xxxxx
sleep-for-rate = true
sleep-time = "300" (optional)
no-archive = true (suggested)
sleep-time = "300" # (optional)
no-archive = true # (suggested)
```

#### google_hits [↑](#supported-data-sources-)
Expand Down Expand Up @@ -950,7 +950,7 @@ Builds from a Jenkins
[jenkins]
raw_index = jenkins_raw
enriched_index = jenkins_enriched
no-archive = true (suggested)
no-archive = true # (suggested)
```
#### jira [↑](#supported-data-sources-)
Issues data from JIRA issue trackers
Expand All @@ -970,9 +970,9 @@ Issues data from JIRA issue trackers
[jira]
raw_index = jira_raw
enriched_index = jira_enriched
no-archive = true (suggested)
backend-user = yyyy (optional)
backend-password = xxxx (optional)
no-archive = true # (suggested)
backend-user = yyyy # (optional)
backend-password = xxxx # (optional)
```
#### kitsune [↑](#supported-data-sources-)
Questions and answers from KitSune
Expand Down Expand Up @@ -1012,9 +1012,9 @@ Messages from Mattermost channels
raw_index = mattermost_raw
enriched_index = mattermost_enriched
api-token = xxxx
studies = [enrich_demography:mattermost] (optional)
studies = [enrich_demography:mattermost] # (optional)

[enrich_demography:mattermost] (optional)
[enrich_demography:mattermost] # (optional)
```
#### mbox [↑](#supported-data-sources-)
Messages from MBox files
Expand Down Expand Up @@ -1055,7 +1055,7 @@ Pages and revisions from MediaWiki
[mediawiki]
raw_index = mediawiki_raw
enriched_index = mediawiki_enriched
no-archive = true (suggested)
no-archive = true # (suggested)
```
#### meetup [↑](#supported-data-sources-)
Events from Meetup groups
Expand All @@ -1080,8 +1080,8 @@ raw_index = meetup_raw
enriched_index = meetup_enriched
api-token = xxxx
sleep-for-rate = true
sleep-time = "300" (optional)
no-archive = true (suggested)
sleep-time = "300" # (optional)
no-archive = true # (suggested)

```
#### mozillaclub [↑](#supported-data-sources-)
Expand Down Expand Up @@ -1146,8 +1146,8 @@ raw_index = pagure_raw
enriched_index = pagure_enriched
api-token = xxxx
sleep-for-rate = true
sleep-time = "300" (optional)
no-archive = true (suggested)
sleep-time = "300" # (optional)
no-archive = true # (suggested)
```
#### phabricator [↑](#supported-data-sources-)
Tasks from Phabricator
Expand All @@ -1168,7 +1168,7 @@ Tasks from Phabricator
raw_index = phabricator_raw
enriched_index = phabricator_enriched
api-token = xxxx
no-archive = true (suggested)
no-archive = true # (suggested)
```
#### pipermail [↑](#supported-data-sources-)
Messages from Pipermail
Expand Down Expand Up @@ -1265,7 +1265,7 @@ enriched_index = rocketchat_enriched
api-token = xxxx
sleep-for-rate = true
user-id = xxxx
no-archive = true (suggested)
no-archive = true # (suggested)
```
#### rss [↑](#supported-data-sources-)
Entries from RSS feeds
Expand Down Expand Up @@ -1307,7 +1307,7 @@ The information needed to monitor slack channels is the channel id.
raw_index = slack_raw
enriched_index = slack_enriched
api-token = xxxx
no-archive = true (suggested)
no-archive = true # (suggested)
```
#### stackexchange [↑](#supported-data-sources-)
Questions, answers and comments from StackExchange
Expand All @@ -1332,7 +1332,7 @@ Questions, answers and comments from StackExchange
raw_index = stackexchange_raw
enriched_index = stackexchange_enriched
api-token = xxxx
no-archive = true (suggested)
no-archive = true # (suggested)
```
#### supybot [↑](#supported-data-sources-)
Messages from Supybot log files
Expand Down Expand Up @@ -1423,11 +1423,11 @@ instance (e.g., https://translations.documentfoundation.org/), via the page <ins
raw_index = weblate_raw
enriched_index = weblate_enriched
api-token = XXXX
no-archive = true (suggested)
sleep-for-rate = true (suggested)
studies = [enrich_demography:weblate] (optional)
no-archive = true # (suggested)
sleep-for-rate = true # (suggested)
studies = [enrich_demography:weblate] # (optional)

[enrich_demography:weblate] (optional)
[enrich_demography:weblate] # (optional)
```

## Micro Mordred [&uarr;](#contents)
Expand Down