From e2ec126d0dd49bac10d8a00d5f63697471505089 Mon Sep 17 00:00:00 2001 From: David Ormsbee Date: Thu, 25 Apr 2019 15:13:59 -0400 Subject: [PATCH] Initial README for Discussion --- .../django_comment_common/README.rst | 1 + lms/djangoapps/discussion/README.rst | 30 +++++++++++++++++++ lms/djangoapps/discussion_api/README.rst | 1 + .../django_comment_client/README.rst | 1 + lms/djangoapps/notification_prefs/README.rst | 1 + lms/djangoapps/notifier_api/README.rst | 1 + lms/lib/comment_client/README.rst | 1 + .../xblock_discussion/README.rst | 1 + 8 files changed, 37 insertions(+) create mode 100644 common/djangoapps/django_comment_common/README.rst create mode 100644 lms/djangoapps/discussion/README.rst create mode 100644 lms/djangoapps/discussion_api/README.rst create mode 100644 lms/djangoapps/django_comment_client/README.rst create mode 100644 lms/djangoapps/notification_prefs/README.rst create mode 100644 lms/djangoapps/notifier_api/README.rst create mode 100644 lms/lib/comment_client/README.rst create mode 100644 openedx/core/lib/xblock_builtin/xblock_discussion/README.rst diff --git a/common/djangoapps/django_comment_common/README.rst b/common/djangoapps/django_comment_common/README.rst new file mode 100644 index 0000000000..80e9568232 --- /dev/null +++ b/common/djangoapps/django_comment_common/README.rst @@ -0,0 +1 @@ +See ``lms/djangoapps/discussion/README.rst`` diff --git a/lms/djangoapps/discussion/README.rst b/lms/djangoapps/discussion/README.rst new file mode 100644 index 0000000000..55f4d317b2 --- /dev/null +++ b/lms/djangoapps/discussion/README.rst @@ -0,0 +1,30 @@ +Status: Maintenance + +Responsibilities +================ +The Discussion app powers the Open edX forums experience. + +Direction: Move and Extract +=========================== +Discussions related functionality is scattered across a number of places and should be better consolidated. Today we have: + +* ``common/djangoapps/django_comment_common`` +* ``lms/djangoapps/discussion`` +* ``lms/djangoapps/discussion_api`` +* ``lms/djangoapps/django_comment_client`` +* ``lms/djangoapps/notification_prefs`` +* ``lms/djangoapps/notifier_api`` +* ``lms/lib/comment_client`` +* ``openedx/core/lib/xblock_builtin/xblock_discussion`` + +Ideally, what we want in the long term is for all of this extracted into a new repository that holds the code for both the inline discussion XBlock as well as all the Django apps. Use of the notifier API should be replaced with edx-ace. + +That being said, it's not clear what the path forward for this app is. Forum functionality is something that has not been actively worked on for a while, and it's been suggested that we should remove this app altogether in favor of having better integration with other more established forum software. This decision is usually complicated by the desire to have tight integration with courseware and access to data for analytics. + +Regardless, check with Product before undertaking any major refactoring work here. + +Glossary +======== + +More Documentation +================== diff --git a/lms/djangoapps/discussion_api/README.rst b/lms/djangoapps/discussion_api/README.rst new file mode 100644 index 0000000000..80e9568232 --- /dev/null +++ b/lms/djangoapps/discussion_api/README.rst @@ -0,0 +1 @@ +See ``lms/djangoapps/discussion/README.rst`` diff --git a/lms/djangoapps/django_comment_client/README.rst b/lms/djangoapps/django_comment_client/README.rst new file mode 100644 index 0000000000..80e9568232 --- /dev/null +++ b/lms/djangoapps/django_comment_client/README.rst @@ -0,0 +1 @@ +See ``lms/djangoapps/discussion/README.rst`` diff --git a/lms/djangoapps/notification_prefs/README.rst b/lms/djangoapps/notification_prefs/README.rst new file mode 100644 index 0000000000..80e9568232 --- /dev/null +++ b/lms/djangoapps/notification_prefs/README.rst @@ -0,0 +1 @@ +See ``lms/djangoapps/discussion/README.rst`` diff --git a/lms/djangoapps/notifier_api/README.rst b/lms/djangoapps/notifier_api/README.rst new file mode 100644 index 0000000000..80e9568232 --- /dev/null +++ b/lms/djangoapps/notifier_api/README.rst @@ -0,0 +1 @@ +See ``lms/djangoapps/discussion/README.rst`` diff --git a/lms/lib/comment_client/README.rst b/lms/lib/comment_client/README.rst new file mode 100644 index 0000000000..80e9568232 --- /dev/null +++ b/lms/lib/comment_client/README.rst @@ -0,0 +1 @@ +See ``lms/djangoapps/discussion/README.rst`` diff --git a/openedx/core/lib/xblock_builtin/xblock_discussion/README.rst b/openedx/core/lib/xblock_builtin/xblock_discussion/README.rst new file mode 100644 index 0000000000..80e9568232 --- /dev/null +++ b/openedx/core/lib/xblock_builtin/xblock_discussion/README.rst @@ -0,0 +1 @@ +See ``lms/djangoapps/discussion/README.rst``