Skip to content

Commit

Permalink
docs(README): update README usages
Browse files Browse the repository at this point in the history
  • Loading branch information
Raphaël Benitte committed Jul 29, 2018
1 parent 1c8d199 commit 0145e6d
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 117 deletions.
188 changes: 71 additions & 117 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ key | required | description

> Show GitLab project members.
![Gitlab project members](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_members.png)
![Gitlab project members](preview/project_members.png)

### parameters

Expand All @@ -88,224 +88,178 @@ key | required | description
y: 0
```















### GitLab Branches
## GitLab Branches

> Show GitLab project branches.
![Gitlab project branches](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_branches.png)

#### parameters
### parameters

key | required | description
----------|----------|--------------------------
`project` | yes | *ID or NAMESPACE/PROJECT_NAME of a project*

#### usage
### usage

``` yaml
# config.yml
dashboards:
- # …
widgets:
- extension: gitlab
widget: Branches
project: gitlab-org/gitlab-ce
columns: 1
rows: 1
x: 0
y: 0
- extension: gitlab
widget: Branches
project: gitlab-org/gitlab-ce
columns: 1
rows: 1
x: 0
y: 0
```


### GitLab Job Histogram
## GitLab Job Histogram

> Show GitLab project job histogram.
![Gitlab project job histogram](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_build_histogram.png)

#### parameters
### parameters

key | required | description
----------|----------|--------------------------
`project` | yes | *ID or NAMESPACE/PROJECT_NAME of a project*

#### usage
### usage

``` yaml
# config.yml
dashboards:
- # …
widgets:
- extension: gitlab
widget: JobHistogram
project: gitlab-org/gitlab-ce
columns: 2
rows: 1
x: 0
y: 0
- extension: gitlab
widget: JobHistogram
project: gitlab-org/gitlab-ce
columns: 2
rows: 1
x: 0
y: 0
```


### GitLab Job History
## GitLab Job History

> Show GitLab project job history.
![Gitlab project job history](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_build_history.png)

#### parameters
### parameters

key | required | description
----------|----------|--------------------------
`project` | yes | *ID or NAMESPACE/PROJECT_NAME of a project*

#### usage
### usage

``` yaml
# config.yml
dashboards:
- # …
widgets:
- extension: gitlab
widget: JobHistory
project: gitlab-org/gitlab-ce
columns: 1
rows: 1
x: 0
y: 0
- extension: gitlab
widget: JobHistory
project: gitlab-org/gitlab-ce
columns: 1
rows: 1
x: 0
y: 0
```

### GitLab Project Contributors
## GitLab Project Contributors

> Show GitLab project contributors.
![Gitlab project contributors](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_project_contributors.png)

#### parameters
### parameters

key | required | description
----------|----------|--------------------------
`project` | yes | *ID or NAMESPACE/PROJECT_NAME of a project*

#### usage
### usage

``` yaml
# config.yml
dashboards:
- # …
widgets:
- extension: gitlab
widget: ProjectContributors
project: gitlab-org/gitlab-ce
columns: 1
rows: 1
x: 0
y: 0
- extension: gitlab
widget: ProjectContributors
project: gitlab-org/gitlab-ce
columns: 1
rows: 1
x: 0
y: 0
```

### GitLab labels bubble chart
## GitLab labels bubble chart

> Show GitLab project's labels stats using a bubble chart.
![Gitlab labels bubble chart](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_labels_bubble.png)

#### parameters
### parameters

key | required | default | description
----------|----------|-----------------------|----------------
`project` | yes | *n/a* | *ID or NAMESPACE/PROJECT_NAME of a project*
`countBy` | yes | `'open_issues_count'` | *Defines which count to use, must be one of: `'open_issues_count'`, `'closed_issues_count'`, `'open_merge_requests_count'`*
`title` | no | *n/a* | *Overrides widget title*

#### usage
### usage

``` yaml
# config.yml
dashboards:
- # …
widgets:
- extension: gitlab
widget: LabelsBubble
project: gitlab-org/gitlab-ce
columns: 1
rows: 1
x: 0
y: 0
- extension: gitlab
widget: LabelsBubble
project: gitlab-org/gitlab-ce
columns: 1
rows: 1
x: 0
y: 0
```


### GitLab labels pie
## GitLab labels pie

> Show GitLab project's labels stats using a pie chart.
![Gitlab labels pie](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_labels_pie.png)

#### parameters
### parameters

key | required | default | description
----------|----------|-----------------------|----------------
`project` | yes | *n/a* | *ID or NAMESPACE/PROJECT_NAME of a project*
`countBy` | yes | `'open_issues_count'` | *Defines which count to use, must be one of: `'open_issues_count'`, `'closed_issues_count'`, `'open_merge_requests_count'`*
`title` | no | *n/a* | *Overrides widget title*

#### usage
### usage

``` yaml
# config.yml
dashboards:
- # …
widgets:
- extension: gitlab
widget: LabelsPie
project: gitlab-org/gitlab-ce
columns: 1
rows: 1
x: 0
y: 0
- extension: gitlab
widget: LabelsPie
project: gitlab-org/gitlab-ce
columns: 1
rows: 1
x: 0
y: 0
```


### GitLab labels tree map
## GitLab labels tree map

> Show GitLab project's labels stats using a tree map chart.
![Gitlab labels tree map](https://raw.githubusercontent.com/plouc/mozaik-ext-gitlab/master/preview/gitlab_labels_treemap.png)

#### parameters
### parameters

key | required | default | description
----------|----------|-----------------------|----------------
`project` | yes | *n/a* | *ID or NAMESPACE/PROJECT_NAME of a project*
`countBy` | yes | `'open_issues_count'` | *Defines which count to use, must be one of: `'open_issues_count'`, `'closed_issues_count'`, `'open_merge_requests_count'`*
`title` | no | *n/a* | *Overrides widget title*

#### usage
### usage

``` yaml
# config.yml
dashboards:
- # …
widgets:
- extension: gitlab
widget: LabelsTreemap
project: gitlab-org/gitlab-ce
columns: 1
rows: 1
x: 0
y: 0
- extension: gitlab
widget: LabelsTreemap
project: gitlab-org/gitlab-ce
columns: 1
rows: 1
x: 0
y: 0
```


Expand Down
Binary file removed preview/gitlab_members.png
View file
Binary file not shown.
Binary file added preview/project_members.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0145e6d

Please sign in to comment.