From c8d999c95fec1dcbb0055f954d9c81978ea1904b Mon Sep 17 00:00:00 2001
From: Shivaram Lingamneni <slingamn@cs.stanford.edu>
Date: Sat, 5 Dec 2020 20:40:44 -0500
Subject: [PATCH] clean up and clarify example operator blocks

See #1426
---
 default.yaml     | 35 ++++++++++++++---------------------
 traditional.yaml | 35 ++++++++++++++---------------------
 2 files changed, 28 insertions(+), 42 deletions(-)

diff --git a/default.yaml b/default.yaml
index eaf94402..9a7cd356 100644
--- a/default.yaml
+++ b/default.yaml
@@ -576,10 +576,10 @@ channels:
 
 # operator classes
 oper-classes:
-    # local operator
-    "local-oper":
+    # IRC operator: can ban and unban users from the server
+    "irc-oper":
         # title shown in WHOIS
-        title: Local Operator
+        title: IRC Operator
 
         # capability names
         capabilities:
@@ -590,32 +590,18 @@ oper-classes:
             - "roleplay"
             - "relaymsg"
 
-    # network operator
-    "network-oper":
-        # title shown in WHOIS
-        title: Network Operator
-
-        # oper class this extends from
-        extends: "local-oper"
-
-        # capability names
-        capabilities:
-            - "remote_kill"
-            - "remote_ban"
-            - "remote_unban"
-
-    # server admin
+    # server admin: has full control of application-level privileges, including
+    # nickname and channel registrations
     "server-admin":
         # title shown in WHOIS
         title: Server Admin
 
         # oper class this extends from
-        extends: "local-oper"
+        extends: "irc-oper"
 
         # capability names
         capabilities:
             - "rehash"
-            - "die"
             - "accreg"
             - "sajoin"
             - "samode"
@@ -626,7 +612,7 @@ oper-classes:
 
 # ircd operators
 opers:
-    # operator named 'admin'; log in with /OPER admin [password]
+    # default operator named 'admin'; log in with /OPER admin <password>
     admin:
         # which capabilities this oper has access to
         class: "server-admin"
@@ -661,6 +647,13 @@ opers:
         # granted automatically as soon as you connect with the right fingerprint.
         #auto: true
 
+    # example of a second, less privileged operator named 'alice'
+    # (log in with /OPER alice <password>):
+    #alice:
+    #    class: "irc-oper"
+    #    whois-line: "can help with moderation issues"
+    #    password: "$2a$04$0123456789abcdef0123456789abcdef0123456789abcdef01234"
+
 # logging, takes inspiration from Insp
 logging:
     -
diff --git a/traditional.yaml b/traditional.yaml
index 225afc9b..7f9f2cfc 100644
--- a/traditional.yaml
+++ b/traditional.yaml
@@ -548,10 +548,10 @@ channels:
 
 # operator classes
 oper-classes:
-    # local operator
-    "local-oper":
+    # IRC operator: can ban and unban users from the server
+    "irc-oper":
         # title shown in WHOIS
-        title: Local Operator
+        title: IRC Operator
 
         # capability names
         capabilities:
@@ -562,32 +562,18 @@ oper-classes:
             - "roleplay"
             - "relaymsg"
 
-    # network operator
-    "network-oper":
-        # title shown in WHOIS
-        title: Network Operator
-
-        # oper class this extends from
-        extends: "local-oper"
-
-        # capability names
-        capabilities:
-            - "remote_kill"
-            - "remote_ban"
-            - "remote_unban"
-
-    # server admin
+    # server admin: has full control of application-level privileges, including
+    # nickname and channel registrations
     "server-admin":
         # title shown in WHOIS
         title: Server Admin
 
         # oper class this extends from
-        extends: "local-oper"
+        extends: "irc-oper"
 
         # capability names
         capabilities:
             - "rehash"
-            - "die"
             - "accreg"
             - "sajoin"
             - "samode"
@@ -598,7 +584,7 @@ oper-classes:
 
 # ircd operators
 opers:
-    # operator named 'admin'; log in with /OPER admin [password]
+    # default operator named 'admin'; log in with /OPER admin <password>
     admin:
         # which capabilities this oper has access to
         class: "server-admin"
@@ -633,6 +619,13 @@ opers:
         # granted automatically as soon as you connect with the right fingerprint.
         #auto: true
 
+    # example of a second, less privileged operator named 'alice'
+    # (log in with /OPER alice <password>):
+    #alice:
+    #    class: "irc-oper"
+    #    whois-line: "can help with moderation issues"
+    #    password: "$2a$04$0123456789abcdef0123456789abcdef0123456789abcdef01234"
+
 # logging, takes inspiration from Insp
 logging:
     -