From c8c82ed4787a4a8247f6b5ef0758fe948e8ef34c Mon Sep 17 00:00:00 2001 From: Matt Prahl Date: Aug 07 2017 21:40:48 +0000 Subject: Reword the README to describe the repo's current structure. --- diff --git a/README.md b/README.md index eac2b35..d4bdcd1 100644 --- a/README.md +++ b/README.md @@ -3,26 +3,30 @@ A ticket queue for dist-git requests and a repository for Bugzilla assignee overrides -## dist-git Tickets +### Tickets For "dist-git" Requests All tickets must be submitted using [fedrepo-req](https://pagure.io/fedrepo_req). This allows other tooling to programmatically process tickets in a format it expects. +### Repository Structure -## Bugzilla Assignee Overrides +The root of the repository contains a list of directories representing the +namespaces in Pagure over dist-git (e.g. rpms). Within those directories, YAML +files will be named after components. The contents of those YAML files will be +in the format of a dictionary, with each key being an option for the repo. + +### Bugzilla Assignee Overrides This repository is used to override the default Bugzilla ticket assignees on a component in a product (e.g "Fedora EPEL" or "Fedora"). By default, the Bugzilla ticket assignee is the **main admin** of the component (e.g. rpms/python-requests) in Pagure over dist-git. -### Structure - -The root of the repository contains a list of directories representing the -namespaces in Pagure over dist-git (e.g. rpms). Within those directories, YAML -files will be named after components. The contents of those YAML files will be -in the format of a dictionary, with each key representing a product -(e.g. "Fedora EPEL" or "Fedora") and each value specifying the email address of -the default Bugzilla ticket assignee for the component in that product. +To override the default assignee in Bugzilla, find/or create the YAML file that +configures the repository you want to set (e.g. rpms/python-requests). The +**bugzilla_contact** key in the YAML file is used to override this with a dictionary, +where each key represents a product (e.g. "Fedora EPEL" or "Fedora"). Each value +should specify the FAS username or FAS group (groups are signified by starting with a +"@") of the default Bugzilla ticket assignee for the component in that product.