From cf7db72fb101ef924991a458f93b9efb873d8c1c Mon Sep 17 00:00:00 2001 From: Ian Young Date: Wed, 12 Dec 2012 11:04:06 +0000 Subject: [PATCH] Document underscore convention for /mdx/ subdirectories. --- mdx/conventions.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/mdx/conventions.md b/mdx/conventions.md index 21a6760d..f8f687d1 100644 --- a/mdx/conventions.md +++ b/mdx/conventions.md @@ -4,9 +4,14 @@ This document describes the current conventions for the metadata aggregation fra Because these conventions have been developed over time, and are still being developed, not all of them are currently implemented by all parts of the framework. These conventions should be applied in their then-current state for any new work, and when significant changes are made to existing code. +## Ruleset Directory + +The `_rules` subdirectory of `/mdx/` holds checking rulesets. The underscore at the start of the directory name is intended to be used as a continuing convention to allow functional subdirectories to be distinguished from channels. + ## Channels -Each directory under `/mdx/` represents a source of metadata, referred to as a +Each directory under `/mdx/` whose name does not start with an underscore +represents a source of metadata, referred to as a channel. In most cases, a channel corresponds to a access management federation. Most channels are named in the form "`country`_`source`". For example,