From 68aed221e03f94445d0df2be99213e691f9eca3f Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Feb 06 2018 13:04:52 +0000 Subject: [PATCH 1/3] Fix a couple of warnings raised by sphinx when building the doc Signed-off-by: Pierre-Yves Chibon --- diff --git a/doc/configuration.rst b/doc/configuration.rst index aff817a..92e9afd 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -581,14 +581,14 @@ This configuration key specifies which authentication method to use. Valid options are ``fas``, ``openid``, ``oidc``, or ``local``. * ``fas`` uses the Fedora Account System `FAS ` -to provide user authentication. + to provide user authentication. * ``openid`` uses OpenID authentication. Any provider may be used by -setting the FAS_OPENID_ENDPOINT option. By default FAS (without FPCA) -will be used. + setting the FAS_OPENID_ENDPOINT option. By default FAS (without FPCA) + will be used. * ``oidc`` enables OpenID Connect using any provider. This provider requires -the configuration options starting with ``OIDC_`` (see below) to be provided. + the configuration options starting with ``OIDC_`` (see below) to be provided. * ``local`` causes pagure to use the local pagure database for user management. diff --git a/doc/usage/flags.rst b/doc/usage/flags.rst index fc0441c..0cf724d 100644 --- a/doc/usage/flags.rst +++ b/doc/usage/flags.rst @@ -37,8 +37,8 @@ with the titles: ``Flag a commit`` or ``Flag a pull-request``. - ``failure``: the task ended but failed. - ``error``: the task did not end at all. - ``pending``: the results of this task are pending. - (for ``failure`` vs ``error`` think of the test system ran the tests but - they failed vs the test system did not get to run the tests) + (for ``failure`` vs ``error`` think of the test system ran the tests but + they failed vs the test system did not get to run the tests) - **percent**: this is an optional field which allows to provide some more details about the outcome of the task. For example this could be used for From ef6d3a66e9b2107e0aa5224bf3021a400478cce9 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Feb 06 2018 13:04:52 +0000 Subject: [PATCH 2/3] Document project intra-pagure hyperlinks Fixes https://pagure.io/pagure/issue/2921 Signed-off-by: Pierre-Yves Chibon --- diff --git a/doc/usage/markdown.rst b/doc/usage/markdown.rst index 95f1c17..6303fc7 100644 --- a/doc/usage/markdown.rst +++ b/doc/usage/markdown.rst @@ -115,6 +115,9 @@ Install the needed system libraries: Hyperlinks ---------- +Regular links +^^^^^^^^^^^^^ + Need to embed a link to somewhere else? No problem! You can create an in-line link by wrapping the text in `[ ]` and appending the the URL in parentheses `( )` immediately after. @@ -124,6 +127,29 @@ parentheses `( )` immediately after. Pagure is used by the `Fedora Project `_. +Links to ticket/PR of the same project +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +You want to link to a ticket or a pull-request in the current project? Easy +just use `#` immediately followed by the identifier of the ticket or +pull-request. + +`This is an example for #2921` + +This is an example for `#2921 `_ + +Links to ticket/PR of another project +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +You want to link to a ticket or a pull-request of a different project? Simply +add the project name in front of the `#` and immediately followed by the +identifier of the ticket or pull-request. + +`This is an example for pagure#2921` + +This is an example for `pagure#2921 `_ + + Lists ----- From ec70f0e04a835cfb02edbd01bb18b33dc7039190 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Feb 06 2018 13:04:52 +0000 Subject: [PATCH 3/3] Remove duplicated 'the' Signed-off-by: Pierre-Yves Chibon --- diff --git a/doc/usage/markdown.rst b/doc/usage/markdown.rst index 6303fc7..414cfe8 100644 --- a/doc/usage/markdown.rst +++ b/doc/usage/markdown.rst @@ -119,7 +119,7 @@ Regular links ^^^^^^^^^^^^^ Need to embed a link to somewhere else? No problem! You can create an -in-line link by wrapping the text in `[ ]` and appending the the URL in +in-line link by wrapping the text in `[ ]` and appending the URL in parentheses `( )` immediately after. `Pagure is used by the [Fedora Project](https://fedoraproject.org).`