From 1ffce3a2071f59fea451f05ce84cc2035d4fdbdb Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Nov 22 2017 16:44:48 +0000 Subject: Add a small documentation blob about flags for commits and PRs Signed-off-by: Pierre-Yves Chibon --- diff --git a/doc/usage/_static/pagure_commit_flag.png b/doc/usage/_static/pagure_commit_flag.png new file mode 100644 index 0000000..cce6b5f Binary files /dev/null and b/doc/usage/_static/pagure_commit_flag.png differ diff --git a/doc/usage/_static/pagure_flag_pr.png b/doc/usage/_static/pagure_flag_pr.png new file mode 100644 index 0000000..9d1205b Binary files /dev/null and b/doc/usage/_static/pagure_flag_pr.png differ diff --git a/doc/usage/flags.rst b/doc/usage/flags.rst new file mode 100644 index 0000000..10e3b30 --- /dev/null +++ b/doc/usage/flags.rst @@ -0,0 +1,38 @@ + +.. _flags: + +Flags +===== + +Pagure offers the possibility to flag pull-requests and commits. A flag +is a way for a third-party tool to provide feedback on a pull-request or a +commit. + +This feedback can be as simple as the outcome of running the tests, or some +lint tool, or test coverage evolution. + + +Add a flag +---------- + +Flags can be set via the API, see the ``/api/`` url in your pagure instance +or at `pagure.io/api/ `_ and look for the endpoints +with the titles: ``Flag a commit`` or ``Flag a pull-request``. + + +.. _example_flag_commit: + +Example of two flags on a commit: +--------------------------------- + +.. image:: _static/pagure_commit_flag.png + :target: ../_images/pagure_commit_flag.png + + +.. _example_flag_pr: + +Example of two flags on a pull-request: +--------------------------------------- + +.. image:: _static/pagure_flag_pr.png + :target: ../_images/pagure_flag_pr.png diff --git a/doc/usage/index.rst b/doc/usage/index.rst index e8f2f8a..681eb2c 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -40,6 +40,7 @@ Contents: project_settings project_acls roadmap + flags using_doc using_webhooks ticket_templates