From 3877bc414d86615e5f7536486a72fd568c039e7a Mon Sep 17 00:00:00 2001 From: Michal Konecny Date: Thu, 2 Nov 2023 16:49:14 +0100 Subject: [PATCH] Small syntax fixes Signed-off-by: Michal Konecny --- docs/dist-git-move/copr.rst | 20 ++++++++++-------- docs/dist-git-move/hotness.rst | 8 +++---- docs/dist-git-move/toddlers.rst | 37 +++++++++++++++++---------------- 3 files changed, 34 insertions(+), 31 deletions(-) diff --git a/docs/dist-git-move/copr.rst b/docs/dist-git-move/copr.rst index 09b87cf..bccc5d4 100644 --- a/docs/dist-git-move/copr.rst +++ b/docs/dist-git-move/copr.rst @@ -17,24 +17,26 @@ Builds logic - COPR is using API calls for flagging dist-git commits or pull requests in `build_logic.py module `_. - It is calling `/api/0//pull-request//flag` and - `/api/0//c//flag` API endpoints. + It is calling ``/api/0//pull-request//flag`` and + ``/api/0//c//flag`` API endpoints. CLI client ^^^^ -- COPR is doing `git clone` from dist-git, which is wrapped in - `copr-distgit-client clone --dist-git fedora `. +- COPR is doing ``git clone`` from dist-git, which is wrapped in + ``copr-distgit-client clone --dist-git fedora ``. Fedora messaging ^^^^ - COPR is listening to following dist-git topics: - * `org.fedoraproject.prod.pagure.git.receive` - * `org.fedoraproject.prod.pagure.pull-request.new` - * `org.fedoraproject.prod.pagure.pull-request.rebased` - * `org.fedoraproject.prod.pagure.pull-request.updated` - * `org.fedoraproject.prod.pagure.pull-request.comment.added` + + * ``org.fedoraproject.prod.pagure.git.receive`` + * ``org.fedoraproject.prod.pagure.pull-request.new`` + * ``org.fedoraproject.prod.pagure.pull-request.rebased`` + * ``org.fedoraproject.prod.pagure.pull-request.updated`` + * ``org.fedoraproject.prod.pagure.pull-request.comment.added`` + - These topics are configured in `frontend messaging configuration `_. diff --git a/docs/dist-git-move/hotness.rst b/docs/dist-git-move/hotness.rst index 9824d35..4dee857 100644 --- a/docs/dist-git-move/hotness.rst +++ b/docs/dist-git-move/hotness.rst @@ -12,9 +12,9 @@ Git and The New Hotness. Validations ^^^^ -- Checking the monitoring setting by calling dist-git `_dg/anitya/rpms/` API in +- Checking the monitoring setting by calling dist-git ``_dg/anitya/rpms/`` API in `pagure module `_ -- Checking the retirement status by HTTP GET request for `dead.package` in +- Checking the retirement status by HTTP GET request for ``dead.package`` in `pagure module `_ Scratch builds @@ -29,7 +29,7 @@ Changes proposed In order to switch out Pagure Dist Git for an alternative that provides a relatively compatible API pattern, the following changes must be made in the -placed mentioned below. +places mentioned below. Necessary ^^^^ @@ -43,7 +43,7 @@ Unnecessary - As hotness is mostly using just plain HTTP, git interactions with dist-git it's not necessary to change much. Only the monitoring settings needs to be provided somewhere. -- Change the default value for `dist_git_url` in +- Change the default value for ``dist_git_url`` in `config module `_. As this could be set in configuration it's not necessary to do that, but it would be nice to change it to new git forge. diff --git a/docs/dist-git-move/toddlers.rst b/docs/dist-git-move/toddlers.rst index dfe1c60..d792c30 100644 --- a/docs/dist-git-move/toddlers.rst +++ b/docs/dist-git-move/toddlers.rst @@ -26,53 +26,54 @@ Pagure module - This `module `_ contains method interacting with pagure or dist-git - Few methods are specific only for dist-git: - * `set_monitoring_status` - * `is_project_orphaned` - * `assign_maintainer_to_project` + + * ``set_monitoring_status`` + * ``is_project_orphaned`` + * ``assign_maintainer_to_project`` clean_retired_packages toddler ^^^^ -- `/_dg/orphan` API endpoint called in `orphan_package` method -- `/_dg/bzoverrides` API endpoint called in `orphan_package` method -- `///git/modifyacls` API endpoint called in `remove_access` method -- `///watchers/update` API endpoint called in `remove_access` method +- ``/_dg/orphan`` API endpoint called in ``orphan_package`` method +- ``/_dg/bzoverrides`` API endpoint called in ``orphan_package`` method +- ``///git/modifyacls`` API endpoint called in ``remove_access`` method +- ``///watchers/update`` API endpoint called in ``remove_access`` method distgit_bugzilla_sync toddler ^^^^ -- `/extras/pagure_poc.json` called in `_get_pagure_projects` -- `/extras/pagure_bz.json` called in `_get_pagure_projects` +- ``/extras/pagure_poc.json`` called in ``_get_pagure_projects`` +- ``/extras/pagure_bz.json`` called in ``_get_pagure_projects`` flag_ci_pr toddler ^^^^ - Listening to following topics: - * `org.centos.*.ci.dist-git-pr.test.error` - * `org.centos.*.ci.dist-git-pr.test.complete` - * `org.centos.*.ci.dist-git-pr.test.running` -- `/api/0///c//flag` called in `process` method + * ``org.centos.*.ci.dist-git-pr.test.error`` + * ``org.centos.*.ci.dist-git-pr.test.complete`` + * ``org.centos.*.ci.dist-git-pr.test.running`` +- ``/api/0///c//flag`` called in ``process`` method flag_commit_build toddler ^^^^ -- `/api/0///c//flag` called in `process` method +- ``/api/0///c//flag`` called in ``process`` method packagers_without_bugzilla toddler ^^^^ -- `/extras/pagure_bz.json` called in `get_user_and_groups_dist_git` method +- ``/extras/pagure_bz.json`` called in ``get_user_and_groups_dist_git`` method pdc_retired_packages toddler ^^^^ -- `///raw//f/dead.package` called in `_is_retired_in_dist_git` method +- ``///raw//f/dead.package`` called in ``_is_retired_in_dist_git`` method pdc_unretire_packages toddler ^^^^ -- `//.git` called in `process_ticket` method -- `git clone` called in `process_ticket` toddler +- ``//.git`` called in ``process_ticket`` method +- ``git clone`` called in ``process_ticket`` toddler Changes proposed ----