Skip to content

Commit fc90d36

Browse files
committed
Add note about how to expand use cases for this command
1 parent c3a4d54 commit fc90d36

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

readthedocs/core/management/commands/contact_owners.py

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import structlog
21
import sys
32
from pathlib import Path
43
from pprint import pprint
54

5+
import structlog
66
from django.conf import settings
77
from django.contrib.auth import get_user_model
88
from django.core.management.base import BaseCommand
@@ -48,6 +48,13 @@ class Command(BaseCommand):
4848
4949
By default the command won't send the email/notification (dry-run mode),
5050
add the ``--production`` flag to actually send the email/notification.
51+
52+
.. note::
53+
54+
If you need to extend the behavior or add a new use case,
55+
we recommend creating a simple script file that re-use the methods and functions from this command.
56+
This is an example to contact Domain owners:
57+
https://gist.github.com/humitos/3e08ed4763a9312f5c0a9a997ea95a42
5158
"""
5259

5360
help = 'Send an email or sticky notification from a file (markdown) to all owners.'

0 commit comments

Comments
 (0)