From aff8d05f75db447afefd28803bb19efc3da7a781 Mon Sep 17 00:00:00 2001 From: Sarina Canelake Date: Thu, 12 Sep 2024 10:47:20 -0400 Subject: [PATCH] Remove the Course Operators persona (#562) * Remove the Course Operators persona * Add ADR about removing Course Operators persona * Provide a bit more clarity on personas --- README.rst | 1 - source/course_ops/concepts/index.rst | 2 - source/course_ops/how-tos/index.rst | 2 - source/course_ops/index.rst | 2 - source/course_ops/quickstarts/index.rst | 19 ---------- source/course_ops/references/index.rst | 2 - source/documentors/concepts/doc_audiences.rst | 6 +-- .../0006-remove-course-operators.rst | 37 +++++++++++++++++++ source/documentors/decisions/index.rst | 1 + .../documentors/references/doc_checklist.rst | 1 - source/index.rst | 29 ++------------- 11 files changed, 43 insertions(+), 59 deletions(-) delete mode 100644 source/course_ops/concepts/index.rst delete mode 100644 source/course_ops/how-tos/index.rst delete mode 100644 source/course_ops/index.rst delete mode 100644 source/course_ops/quickstarts/index.rst delete mode 100644 source/course_ops/references/index.rst create mode 100644 source/documentors/decisions/0006-remove-course-operators.rst diff --git a/README.rst b/README.rst index 3e4f0537b..b4b7a06f0 100644 --- a/README.rst +++ b/README.rst @@ -6,7 +6,6 @@ This repository contains source files for the `Open edX Documentation`_ site. Th The `Open edX Documentation`_ site contains complete documentation for: * Educators -* Course Operators * Site Operators * Developers diff --git a/source/course_ops/concepts/index.rst b/source/course_ops/concepts/index.rst deleted file mode 100644 index 2ac8d7a19..000000000 --- a/source/course_ops/concepts/index.rst +++ /dev/null @@ -1,2 +0,0 @@ -Course Ops: Concepts -#################### diff --git a/source/course_ops/how-tos/index.rst b/source/course_ops/how-tos/index.rst deleted file mode 100644 index 298d0c0bb..000000000 --- a/source/course_ops/how-tos/index.rst +++ /dev/null @@ -1,2 +0,0 @@ -Course Ops: How-tos -################### diff --git a/source/course_ops/index.rst b/source/course_ops/index.rst deleted file mode 100644 index dcde96db1..000000000 --- a/source/course_ops/index.rst +++ /dev/null @@ -1,2 +0,0 @@ -Open edX Course Operators -######################### diff --git a/source/course_ops/quickstarts/index.rst b/source/course_ops/quickstarts/index.rst deleted file mode 100644 index 9d7934510..000000000 --- a/source/course_ops/quickstarts/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -Course Ops: Quick Start -####################### - -.. contents:: Main Tasks - :local: - :depth: 1 - - -Set up Cohorts -************** - -View Grades -*********** - -Assign a Grade -************** - -End a Course -************ diff --git a/source/course_ops/references/index.rst b/source/course_ops/references/index.rst deleted file mode 100644 index 79998987a..000000000 --- a/source/course_ops/references/index.rst +++ /dev/null @@ -1,2 +0,0 @@ -Course Ops: References -###################### diff --git a/source/documentors/concepts/doc_audiences.rst b/source/documentors/concepts/doc_audiences.rst index e7f19074b..85d8b1d94 100644 --- a/source/documentors/concepts/doc_audiences.rst +++ b/source/documentors/concepts/doc_audiences.rst @@ -3,11 +3,9 @@ Documentation Audiences Open edX documentation is organized by the following audiences: -* **Educators**, who build online courses using Studio. +* **Educators**, who build and/or run online courses using Studio. -* **Course Operators**, who run online courses, using features in the LMS. - -* **Site Operators**, who install and configure Open edX. +* **Site Operators**, who install, deploy, and configure Open edX sites. * **Developers**, who contribute new features or bug fixes to the core Open edX platform, or develop other components and XBlocks that integrate with the core platform. diff --git a/source/documentors/decisions/0006-remove-course-operators.rst b/source/documentors/decisions/0006-remove-course-operators.rst new file mode 100644 index 000000000..55cd1f882 --- /dev/null +++ b/source/documentors/decisions/0006-remove-course-operators.rst @@ -0,0 +1,37 @@ +Remove Course Operators persona +############################### + +Status +****** + +**Accepted** + +Context +******* + +As documented in :doc:`0001-purpose-of-this-repo`, we list out a number of +target personas for whom to create documentation; one of these is the "course +operator" persona, defined as those who run an Open edX course. + +In practice, we have not developed documentation for this persona. We have found +that there is a very blurry line between someone who authors a course (an +"Educator") and someone who runs one. As such, documentation about how to +utilize a given feature frequently combines the needs of an educator and a +course operator into one document. + +Decision +******** + +We will no longer have the persona of "Course Operator". This was discussed in +multiple Documentation Working Group meetings in August and September of 2024. + +All documentation related to building/authoring a course, running a course, and +utilizing all "course personell"-type software (including but not limited to +Studio, the LMS Instructor Dashboard, the Staff Debug interface, and Aspects) +will lie under the "Educator" persona. + +Consequences +************ + +* All pages for Course Operators will be deleted. There was never any authored + content on these pages; they were just stubs. diff --git a/source/documentors/decisions/index.rst b/source/documentors/decisions/index.rst index 4befbac24..d650cd7d7 100644 --- a/source/documentors/decisions/index.rst +++ b/source/documentors/decisions/index.rst @@ -12,3 +12,4 @@ Documentation Decisions 3. Documentation Layout <0003-documentation-layout> 4. Don't Use AutoSectionLabel Extension <0004-no-auto-section-label> 5. Use Markdown READMEs for repos published to npm <0005-markdown-for-npm-readmes> + 6. Remove Course Operators persona <0006-remove-course-operators> diff --git a/source/documentors/references/doc_checklist.rst b/source/documentors/references/doc_checklist.rst index 2cbe18a4c..3d2e99973 100644 --- a/source/documentors/references/doc_checklist.rst +++ b/source/documentors/references/doc_checklist.rst @@ -13,7 +13,6 @@ Your Audience Make sure your documentation is targeted to the right audience and organized under that audience's section of the documentation. Each topic in the documentation is for one of the following audiences: * Educators -* Course Operators * Site Operators * Developers diff --git a/source/index.rst b/source/index.rst index c191629ef..738970267 100644 --- a/source/index.rst +++ b/source/index.rst @@ -11,7 +11,6 @@ Open edX Documentation Community Educators - Course Operators Site Operators Developers Documentors @@ -30,7 +29,6 @@ Open edX Documentation :caption: Quick Starts Educators: Build a Course - Course Operators: Run a Course Site Operators: Set up Open edX Developers: Contribute to Open edX Documentors: First Documentation PR @@ -54,7 +52,7 @@ Open edX Documentation .. toctree:: :maxdepth: 1 - :caption: Educators: Build an Open edX Course + :caption: Educators: Build and/or Run an Open edX Course Quickstarts How-tos @@ -69,27 +67,6 @@ Open edX Documentation Educators' Home - .. grid-item-card:: - :class-card: sd-shadow-md sd-p-2 - :class-footer: sd-border-0 - - .. toctree:: - :maxdepth: 1 - :caption: Course Operators: Run Open edX - - Quickstarts - How-tos - Concepts - References - - +++ - .. button-ref:: course_ops/index - :color: primary - :outline: - :expand: - - Course Operators' Home - .. grid-item-card:: :class-card: sd-shadow-md sd-p-2 :class-footer: sd-border-0 @@ -138,7 +115,7 @@ Open edX Documentation .. toctree:: :maxdepth: 1 - :caption: Documentors + :caption: Documentors: Document the Open edX Platform Quickstarts How-tos @@ -159,7 +136,7 @@ Open edX Documentation .. toctree:: :maxdepth: 1 - :caption: Translators + :caption: Translators: Translate the Open edX Platform Quickstarts How-tos