Skip to content

Commit b209d90

Browse files
authored
30/60 day ownership tasks (#32)
- Fill out README description (TODO ARCHBOM-1248: publish docs) - Add PII annotation and mark OEP-30 compliant - Update openedx.yaml with correct owner (obsoleted soon, but while I'm in here...)
1 parent c12e4db commit b209d90

File tree

3 files changed

+19
-11
lines changed

3 files changed

+19
-11
lines changed

README.rst

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,22 @@ edx-celeryutils
2525
:target: https://github.com/edx/edx-celeryutils/blob/master/LICENSE.txt
2626
:alt: License
2727

28-
The ``README.rst`` file should start with a brief description of the repository,
29-
which sets it in the context of other repositories under the ``edx``
30-
organization. It should make clear where this fits in to the overall edX
31-
codebase.
32-
33-
Code to support working with celery
28+
Code to support working with Celery, a distributed task queue.
3429

3530
Overview (please modify)
3631
------------------------
3732

38-
The ``README.rst`` file should then provide an overview of the code in this
39-
repository, including the main components and useful entry points for starting
40-
to understand the code in more detail.
33+
This package contains utilities to wrap tasks with logging and to
34+
persist them if they fail.
35+
36+
It also supports Django administration for searching and deleting
37+
failed tasks, and management commands for rerunning failed tasks and
38+
deleting old ones.
4139

4240
Documentation
4341
-------------
4442

45-
The full documentation is at https://edx-celeryutils.readthedocs.org.
43+
(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)
4644

4745
Publishing a Release
4846
--------------------

celery_utils/models.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@
2424
class FailedTask(TimeStampedModel):
2525
"""
2626
Representation of tasks that have failed.
27+
28+
.. pii::
29+
Stores arbitrary task parameters, which theoretically could include
30+
email addresses, although as of May 2020 does not seem to.
31+
Old tasks can be manually deleted in the Django administration UI.
32+
.. pii_retirement: local_api
33+
.. pii_types: other
2734
"""
2835

2936
task_name = models.CharField(max_length=255)

openedx.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# openedx.yaml
22

33
---
4-
owner: edx/teaching-and-learning
4+
owner:
5+
type: team
6+
team: edx/arch-bom
57
nick: edx-celeryutils
68
tags:
79
- tools
@@ -14,3 +16,4 @@ oeps:
1416
state: False
1517
reason: Not relevant to this app
1618
oep-7: True
19+
oep-30: True

0 commit comments

Comments
 (0)