diff options
author | Achilleas Pipinellis <axil@gitlab.com> | 2018-04-06 18:27:09 +0200 |
---|---|---|
committer | Achilleas Pipinellis <axil@gitlab.com> | 2018-04-06 18:27:09 +0200 |
commit | 05b404a610465b153f881a69e511376758c5ac1b (patch) | |
tree | b5a874105ffa461c9918e594f551dc5bee62d3a4 | |
parent | 04571f35cbc6e50e51360dc33c7ae648538690aa (diff) | |
download | gitlab-ce-winh-badges-docs.tar.gz |
Copyedit badges docswinh-badges-docs
-rw-r--r-- | doc/api/group_badges.md | 6 | ||||
-rw-r--r-- | doc/api/project_badges.md | 6 | ||||
-rw-r--r-- | doc/user/project/badges.md | 79 | ||||
-rw-r--r-- | doc/user/project/img/add_badge_form.png | bin | 61852 -> 0 bytes | |||
-rw-r--r-- | doc/user/project/img/group_badges_list.png | bin | 63345 -> 0 bytes | |||
-rw-r--r-- | doc/user/project/img/project_badges_list.png | bin | 85876 -> 0 bytes |
6 files changed, 43 insertions, 48 deletions
diff --git a/doc/api/group_badges.md b/doc/api/group_badges.md index e9bb630b5bd..0d7d0fd9c42 100644 --- a/doc/api/group_badges.md +++ b/doc/api/group_badges.md @@ -1,7 +1,7 @@ # Group badges API -> **Notes:** -> [Introduced][ce-17082] in GitLab 10.6. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/17082) +in GitLab 10.6. ## Placeholder tokens @@ -192,5 +192,3 @@ Example response: "rendered_image_url": "https://shields.io/my/badge", } ``` - -[ce-17082]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/17082 diff --git a/doc/api/project_badges.md b/doc/api/project_badges.md index 36189b71d5d..94389273e9c 100644 --- a/doc/api/project_badges.md +++ b/doc/api/project_badges.md @@ -1,7 +1,7 @@ # Project badges API -> **Notes:** -> [Introduced][ce-17082] in GitLab 10.6. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/17082) +in GitLab 10.6. ## Placeholder tokens @@ -189,5 +189,3 @@ Example response: "rendered_image_url": "https://shields.io/my/badge", } ``` - -[ce-17082]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/17082 diff --git a/doc/user/project/badges.md b/doc/user/project/badges.md index a643a694aee..c4e59444ef7 100644 --- a/doc/user/project/badges.md +++ b/doc/user/project/badges.md @@ -1,74 +1,73 @@ # Badges -Badges are a unified way to present condensed pieces of information about your projects. -They consist of a small image and additionally a URL that it points to. -Examples for badges can be the [pipeline status], [test coverage], or ways to contact the project maintainers. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/41174) +in GitLab 10.7. + +Badges are a unified way to present condensed pieces of information about your +projects. They consist of a small image and additionally a URL that the image +points to. Examples for badges can be the [pipeline status], [test coverage], +or ways to contact the project maintainers. ![Badges on Project overview page](img/project_overview_badges.png) ## Project badges -> **Notes:** -> [Introduced][ce-41174] in GitLab 10.7 - Badges can be added to a project and will then be visible on the project's overview page. If you find that you have to add the same badges to several projects, you may want to add them at the [group level](#group-badges). To add a new badge to a project: 1. Navigate to your project's **Settings > Badges**. -1. Enter the URL that the badges should point to (`Link`) and the URL of the image that should be displayed (`Badge image URL`). -1. Submit the badge by clicking the `Add badge` button. - -![Add a badge to a project](img/add_badge_form.png) - -After adding a badge to a project, you can see it in the list below the form: +1. Under "Link", enter the URL that the badges should point to and under + "Badge image URL" the URL of the image that should be displayed. +1. Submit the badge by clicking the **Add badge** button. -![List of project badges](img/project_badges_list.png) +After adding a badge to a project, you can see it in the list below the form. +You can edit it by clicking on the pen icon next to it or to delete it by +clicking on the trash icon. -It is now possible to edit the badge by clicking on the pen icon next to it or to delete it by clicking on the trash icon. -Badges associated with a group can only be edited or deleted on the [group level](#group-badges). +Badges associated with a group can only be edited or deleted on the +[group level](#group-badges). ## Group badges -> **Notes:** -> [Introduced][ce-41176] in GitLab 10.7 - -Badges can be added to a group and will then be visible on every contained project's overview page. -In this case they cannot be edited on the project level. -If you need to have individual badges for each project, consider adding them on the [project level](#project-badges) or to use [placeholders](#placeholders). +Badges can be added to a group and will then be visible on every project's +overview page that's under that group. In this case, they cannot be edited or +deleted on the project level. If you need to have individual badges for each +project, consider adding them on the [project level](#project-badges) or use +[placeholders](#placeholders). To add a new badge to a group: 1. Navigate to your group's **Settings > Project Badges**. -1. Enter the URL that the badges should point to (`Link`) and the URL of the image that should be displayed (`Badge image URL`). -1. Submit the badge by clicking the `Add badge` button. - -![Add a badge to a project](img/add_badge_form.png) - -After adding a badge to a group, you can see it in the list below the form: +1. Under "Link", enter the URL that the badges should point to and under + "Badge image URL" the URL of the image that should be displayed. +1. Submit the badge by clicking the **Add badge** button. -![List of group badges](img/group_badges_list.png) +After adding a badge to a group, you can see it in the list below the form. +You can edit the badge by clicking on the pen icon next to it or to delete it +by clicking on the trash icon. -It is now possible to edit the badge by clicking on the pen icon next to it or to delete it by clicking on the trash icon. -Badges directly associated with a project can be configured on the [project level](#project-badges). +Badges directly associated with a project can be configured on the +[project level](#project-badges). ## Placeholders -The URL a badge points as well as the image URL can contain placeholders which will be evaluated when displaying the badge. -The following placeholders are available: +The URL a badge points to, as well as the image URL, can contain placeholders +which will be evaluated when displaying the badge. The following placeholders +are available: -* `%{project_path}`: Path of a project including the parent groups -* `%{project_id}`: Database ID associated with a project -* `%{default_branch}`: Default branch name configured for a project's repository -* `%{commit_sha}`: ID of the most recent commit to the default branch of a project's repository +- `%{project_path}`: Path of a project including the parent groups +- `%{project_id}`: Database ID associated with a project +- `%{default_branch}`: Default branch name configured for a project's repository +- `%{commit_sha}`: ID of the most recent commit to the default branch of a + project's repository ## API -You can also configure badges via the GitLab API. -As in the settings, there is a distinction between endpoints for badges on [project level](../../api/project_badges.md) and [group level](../../api/group_badges.md). +You can also configure badges via the GitLab API. As in the settings, there is +a distinction between endpoints for badges on the +[project level](../../api/project_badges.md) and [group level](../../api/group_badges.md). -[ce-41174]: https://gitlab.com/gitlab-org/gitlab-ce/issues/41174 -[ce-41176]: https://gitlab.com/gitlab-org/gitlab-ce/issues/41176 [pipeline status]: pipelines/settings.md#pipeline-status-badge [test coverage]: pipelines/settings.md#test-coverage-report-badge diff --git a/doc/user/project/img/add_badge_form.png b/doc/user/project/img/add_badge_form.png Binary files differdeleted file mode 100644 index 3f18765e3f3..00000000000 --- a/doc/user/project/img/add_badge_form.png +++ /dev/null diff --git a/doc/user/project/img/group_badges_list.png b/doc/user/project/img/group_badges_list.png Binary files differdeleted file mode 100644 index 81ac7b05b98..00000000000 --- a/doc/user/project/img/group_badges_list.png +++ /dev/null diff --git a/doc/user/project/img/project_badges_list.png b/doc/user/project/img/project_badges_list.png Binary files differdeleted file mode 100644 index c8a65c4de79..00000000000 --- a/doc/user/project/img/project_badges_list.png +++ /dev/null |