From 4d417699d39c799e9f63ef1bb7740259b45d1fa4 Mon Sep 17 00:00:00 2001 From: Ben Cotton Date: Aug 27 2020 18:49:34 +0000 Subject: Add some info about the mechanics of this that are hopefully not lies --- diff --git a/council/modules/ROOT/pages/procedures/team_directory.adoc b/council/modules/ROOT/pages/procedures/team_directory.adoc index 4c2df42..7615c34 100644 --- a/council/modules/ROOT/pages/procedures/team_directory.adoc +++ b/council/modules/ROOT/pages/procedures/team_directory.adoc @@ -44,3 +44,21 @@ They are _not_ responsible for _providing_ the information. Representatives may delegate sections of their area as they see fit. Checks can be done at any time, but should be done around the branch date for each release at a minimum. +== Mechanism + +WARNING: This section has been written by bcotton based on his understanding of how the mechanism works. +Treat it with caution until asamalik verifies it and removes this warning. + +=== Team information files + +The directory requires two teams per file, described below. +The files may be stored in the team's own documentation repository or in the https://pagure.io/Fedora-Council/council-docs/[council-docs repository]. + +* `TEMPLATE_team_info.adoc`: This file contains the information about the team. +* `team_render.adoc`: This file contains the AsciiDoc markup to display the content. + +=== Rendering the directory + +Teams will appear in the directory if the team_info and team_render files are included in the `{engineering,mindshare}/modules/ROOT/pages/index.adoc` files in the https://pagure.io/Fedora-Council/council-docs/[council-docs repo]. + +