From ca8a950b6417f81af2f730f3eb4d52f47cc2452a Mon Sep 17 00:00:00 2001 From: Chris Caron Date: Sun, 15 Oct 2023 17:49:02 -0400 Subject: [PATCH] Updated config_yaml (markdown) --- config_yaml.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/config_yaml.md b/config_yaml.md index b0109db..20707aa 100644 --- a/config_yaml.md +++ b/config_yaml.md @@ -115,6 +115,8 @@ urls: ### Tag Grouping New in v1.6.0 is Tag Grouping! This allows you to assign a group to previous tags defined. ```yaml +# Group Example #1 + # Define your Groups groups: friends: user1, user2 @@ -131,6 +133,8 @@ With respect to `Group Example #1` above, you could now send a notification to t Another great thing about groups is you can assign groups to groups to recursively include everything they're apart of: ```yaml +# Group Example #2 + # Define your Groups groups: finance: user1, user2 @@ -160,6 +164,8 @@ With respect to `Group Example #2` above, you could now send a notification to t You can also assign tags to multiple groups: ```yaml +# Group Example #3 + # Define your Groups groups: # Multiple Group Assignments; reuse of a tag causes existing assignment @@ -182,6 +188,43 @@ urls: With respect to `Group Example #3` above, we have 3 group tags created (TeamA, TeamB, and Friends). TeamA includes user1 and user3, and Team B contains user2 and user4. The Friends tag actually includes user1, user2, user3, and user4 (all entries stacked). +Finally with YAML Files, you can define your groups as lists +```yaml +# Group Example #4 + +# Define your Groups +groups: + # Another way you can define your groups + # This defines a group called 'friends' and allows you to place comments + # That you can place to make your configuration file easier to read: + friends: + - user1: Place an optional comment here; this is ignored and only tagX is retrieved + - user2: Another spot to place an optional comment + - user3: Another spot to place an optional comment + - user4: Another spot to place an optional comment + + # You can define it the same way as above as a list too): + buddies: + - user1 + - user2 + - user3 + - user4 + +# Define your URLs +urls: + # One-liner (no colon at the end); just the url as you'd expect it: + - mailto://credentials: + - tag: user1 + - mailto://credentials: + - tag: user2 + - mailto://credentials: + - tag: user3 + - mailto://credentials: + - tag: user4 +``` + +With respect to `Group Example #4` above, we have 2 group tags created (buddies and friends). The list just shows other ways the groups can be defined. + **Some Notes:** - There is no requirement to define the group before or after the URLs that are defined. - Tags associated with a group that are not used are just ignored.