add example config

jupyterhub/spawner.py

@@ -327,6 +327,29 @@ def _default_access_scopes(self):
           If the traitlet being overriden is a *dictionary*, the dictionary
           will be *recursively updated*, rather than overriden. If you want to
           remove a key, set its value to `None`
+
+        The following example config will:
+
+        1. Add the environment variable "AM_I_USER" to everyone in the "user" group
+        2. Add the environment variable "AM_I_ADMIN" to everyone in the "admin" group.
+           If a user is part of both "user" and "admin", they will get *both* these env
+           vars, due to the dictionary merging functionality.
+        3. Add a higher memory limit for everyone in the "admin" group.
+
+        c.Spawner.group_overrides = {
+            "01-admin-env-add": {
+                "groups": ["admin"],
+                "spawner_override": {"environment": {"AM_I_ADMIN": "yes"}},
+            },
+            "02-user-env-add": {
+                "groups": ["user"],
+                "spawner_override": {"environment": {"AM_I_USER": "yes"}},
+            },
+            "03-admin-mem-limit": {
+                "groups": ["admin"],
+                "spawner_override": {"mem_limit": "2G"}
+            }
+        }
         """,
         config=True,
     )