Merge pull request #607 from jswope00/jswope00/rst_tags

Jswope00/rst tags
openedx · Nov 11, 2024 · c90d050 · c90d050
2 parents 5927bea + 6109158
commit c90d050
Show file tree

Hide file tree

Showing 354 changed files with 722 additions and 463 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 build
+_tags
 .DS_Store
 source/.DS_Store
 .idea/

diff --git a/requirements/base.in b/requirements/base.in
@@ -11,3 +11,4 @@ sphinxcontrib-mermaid
 sphinxcontrib-images
 sphinxcontrib-contentui
 sphinxext-rediraffe
+sphinx-tags
diff --git a/requirements/base.txt b/requirements/base.txt
@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
-#    make upgrade
+#    pip-compile requirements/base.in
 #
 accessible-pygments==0.0.5
     # via pydata-sphinx-theme
@@ -73,6 +73,7 @@ sphinx==7.4.7
     #   sphinx-book-theme
     #   sphinx-copybutton
     #   sphinx-design
+    #   sphinx-tags
     #   sphinxcontrib-contentui
     #   sphinxcontrib-images
     #   sphinxcontrib-mermaid
@@ -86,6 +87,8 @@ sphinx-copybutton==0.5.2
     # via -r requirements/base.in
 sphinx-design==0.6.1
     # via -r requirements/base.in
+sphinx-tags==0.4
+    # via -r requirements/base.in
 sphinxcontrib-applehelp==2.0.0
     # via sphinx
 sphinxcontrib-contentui==0.2.5

diff --git a/source/conf.py b/source/conf.py
@@ -47,6 +47,7 @@
     "sphinxcontrib.mermaid",
     "sphinx.ext.intersphinx",
     "sphinxext.rediraffe",
+    "sphinx_tags"
 ]
 
 # Extension Configuration
@@ -56,6 +57,23 @@
     "community/release_notes/latest.rst": "community/release_notes/redwood.rst",
 }
 
+tags_create_tags = True
+tags_create_badges = True
+
+tags_badge_colors = {
+    "educator": "primary",
+    "developer": "primary",
+    "site operator": "primary",
+    "community": "primary",
+    "documentor": "primary",
+    "translator": "primary",
+    "concept": "secondary",
+    "how-to": "secondary",
+    "quickstart": "secondary",
+    "reference": "secondary",
+    "*": "dark",  # Used as a default value
+}
+
 # Intersphinx Extension Configuration
 DIGITS_ONLY = r"^\d+$"
 rtd_language = os.environ.get("READTHEDOCS_LANGUAGE", "en")

diff --git a/source/educators/concepts/accessibility/accessibility_guidelines.rst b/source/educators/concepts/accessibility/accessibility_guidelines.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _edX Accessibility Guidelines:
 
 ===============================================================
 What Is The edX Accessibility Best Practices Guidance Based On?
 ===============================================================
 
+.. tags:: educator, concept
+
 .. note:: This content has been migrated from legacy edx.org docs and has not yet been adjusted for the Open edX® Community
 
 edX measures and evaluates accessibility primarily using the World Wide Web Consortium's

diff --git a/source/educators/concepts/accessibility/best_practices_course_content_dev.rst b/source/educators/concepts/accessibility/best_practices_course_content_dev.rst
@@ -4,6 +4,8 @@
 Accessibility Best Practices for Developing Course Content
 ##########################################################
 
+.. tags:: educator, concept
+
 edX is dedicated to creating a platform that is not only itself accessible, but
 also enables course content creators to create accessible content. If you
 encounter platform issues that you believe might affect your ability to provide

diff --git a/source/educators/concepts/accessibility/design_for_mobile.rst b/source/educators/concepts/accessibility/design_for_mobile.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _Designing for Mobile:
 
 ###############################################
 Designing Your Course For a Mobile Experience
 ###############################################
 
+.. tags:: educator, concept
+
 Keep in
 mind that the courses and course content that you create should be accessible
 to everyone, regardless of any physical limitation that they might have, and

diff --git a/source/educators/concepts/accessibility/supporting_learners_diverse_needs.rst b/source/educators/concepts/accessibility/supporting_learners_diverse_needs.rst
@@ -4,6 +4,8 @@
 Supporting Learners with Diverse Needs
 ######################################
 
+.. tags:: educator, concept
+
 Almost one fifth of the world's population has some kind of disability. Online
 courses can reduce many barriers to education for these learners by providing
 access to courses from any location, at any time, and through the use of

diff --git a/source/educators/concepts/advanced_features/cohorts_overview.rst b/source/educators/concepts/advanced_features/cohorts_overview.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _Cohorts Overview:
 
 #############################
 Using Cohorts in Your Courses
 #############################
 
+.. tags:: educator, concept
+
 This section provides an introduction to using cohorts to divide the learners
 in your course into smaller groups.
 

diff --git a/source/educators/concepts/advanced_features/content_experiments_overview.rst b/source/educators/concepts/advanced_features/content_experiments_overview.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _Overview of Content Experiments:
 
 #################################
 Overview of Content Experiments
 #################################
 
+.. tags:: educator, concept
+
 
 You use content experiments to show different course content to different
 groups of learners. Also known as "A/B tests" or "split tests", content

diff --git a/source/educators/concepts/advanced_features/group_configurations.rst b/source/educators/concepts/advanced_features/group_configurations.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _Overview of Group Configurations:
 
 ****************************************
 Overview of Group Configurations
 ****************************************
 
+.. tags:: educator, concept
+
 Before you can create :ref:`content experiments<Overview of Content
 Experiments>`, you must specify at least one group configuration for your
 course.

diff --git a/...ducators/concepts/advanced_features/guidlines_modifying_group_configuration.rst b/...ducators/concepts/advanced_features/guidlines_modifying_group_configuration.rst
@@ -1,11 +1,12 @@
-.. :diataxis-type: concept
 .. Section is shared in CA and OLX guides
 .. _Guidelines for Modifying Group Configurations:
 
 *********************************************
 Guidelines for Modifying Group Configurations
 *********************************************
 
+.. tags:: educator, concept
+
 Review these guidelines if you must modify a group configuration after a course
 starts. These guidelines apply for courses built in Studio or using OLX (open
 learning XML).

diff --git a/source/educators/concepts/advanced_features/lti_reuse_content.rst b/source/educators/concepts/advanced_features/lti_reuse_content.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _Reusing Course Content:
 
 ##########################################
 Reusing Course Content with LTI
 ##########################################
 
+.. tags:: educator, concept
+
 .. only:: Partners
 
 .. note:: This feature was a closed pilot experiment. This feature is not

diff --git a/source/educators/concepts/advanced_features/managing_teams_discussions.rst b/source/educators/concepts/advanced_features/managing_teams_discussions.rst
@@ -1,12 +1,12 @@
-.. :diataxis-type: concept
-
 .. _Teams Discussions:
 
 
 #########################
 Managing Team Discussions
 #########################
 
+.. tags:: educator, concept
+
 EdX recommends that you designate course staff and optionally student teaching
 assistants (TAs) to moderate team discussions. The same discussion
 administration roles for managing course discussions on the **Discussions** page

diff --git a/source/educators/concepts/advanced_features/offering_differentiated_content.rst b/source/educators/concepts/advanced_features/offering_differentiated_content.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _Offering Differentiated Content:
 
 #######################################################
 Offering Different Content to Different Learner Groups
 #######################################################
 
+.. tags:: educator, concept
+
 You can design your course so that some learners are given different content
 than others, based on the group that they belong to. Learners can be grouped
 either by :ref:`cohort<Cohort>`, or by the :ref:`enrollment

diff --git a/source/educators/concepts/advanced_features/teams_learner_experience.rst b/source/educators/concepts/advanced_features/teams_learner_experience.rst
@@ -1,12 +1,12 @@
-.. :diataxis-type: concept
-
 .. _CA Learner Experience of Teams:
 
 
 ##########################################
 The Learner's Experience of Teams
 ##########################################
 
+.. tags:: educator, concept
+
 After you have :ref:`enabled teams <Teams Setup>` and created topics in your
 course, learners can begin browsing topics and joining teams. Teams are formed
 within topics. Each learner can belong to only one team.

diff --git a/source/educators/concepts/advanced_features/teams_overview.rst b/source/educators/concepts/advanced_features/teams_overview.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _CA_Teams_Overview:
 
 *******************************
 Teams Overview
 *******************************
 
+.. tags:: educator, concept
+
 Using teams in your course is an effective way for learners to interact and
 collaborate on small group projects or activities. You define the structure of
 teams in your course by defining "team-sets", groups of teams based around a specific

diff --git a/source/educators/concepts/advanced_features/timed_exams.rst b/source/educators/concepts/advanced_features/timed_exams.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _Timed Exams:
 
 ######################
 Timed Exams
 ######################
 
+.. tags:: educator, concept
+
 This topic describes how to add and manage timed exams in your course.
 
 .. contents::

diff --git a/source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst b/source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _Using Open edX as an LTI Tool Provider:
 
 #######################################
 Using Open edX as an LTI Tool Provider
 #######################################
 
+.. tags:: educator, concept
+
 .. note:: This feature was a closed pilot experiment. This feature is not
  supported for new users.
 

diff --git a/source/educators/concepts/communication/about_divided_discussions.rst b/source/educators/concepts/communication/about_divided_discussions.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _About Divided Discussions:
 
 ###################################
 About Divided Discussion Topics
 ###################################
 
+.. tags:: educator, concept
+
 This section provides information about setting up discussions that are
 divided by learner groups (cohorts) within your course.
 

diff --git a/source/educators/concepts/communication/course_discussions.rst b/source/educators/concepts/communication/course_discussions.rst
@@ -1,10 +1,10 @@
-.. :diataxis-type: concept
-
 .. _Discussions:
 
 About Course Discussions
 ###########################
 
+.. tags:: educator, concept
+
 Discussions in an edX course include both course-wide topics of interest to
 all learners (such as "Feedback", "Troubleshooting", or "Technical Help") as
 well as content-specific topics that you add to course units as discussion

diff --git a/source/educators/concepts/communication/discussion_guidance_moderators.rst b/source/educators/concepts/communication/discussion_guidance_moderators.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _Guidance for Discussion Moderators:
 
 ######################################
 Guidance for Discussion Moderators
 ######################################
 
+.. tags:: educator, concept
+
 Discussion forums are hugely important tools in running a successful MOOC;
 they allow for substantive community development, in addition to being
 excellent sources of feedback and ideas for future iterations of the course.

diff --git a/source/educators/concepts/communication/manage_divided_discussions.rst b/source/educators/concepts/communication/manage_divided_discussions.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _Managing Divided Discussion Topics:
 
 ###################################
 Managing Divided Discussion Topics
 ###################################
 
+.. tags:: educator, concept
+
 This section provides information about managing :ref:`discussions<Discussions>`
 that are divided based on learner groups (:ref:`cohorts<Cohort>`).
 

diff --git a/source/educators/concepts/communication/moderating_discussions.rst b/source/educators/concepts/communication/moderating_discussions.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _Moderating_discussions:
 
 #######################
 Moderating Discussions
 #######################
 
+.. tags:: educator, concept
+
 Developing and sustaining a positive discussion culture requires that a team of
 discussion moderators dedicates sufficient time to reviewing discussions and
 responding to questions from learners. Keeping up-to-date with a large MOOC

diff --git a/source/educators/concepts/communication/running_discussions.rst b/source/educators/concepts/communication/running_discussions.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _Running_discussions:
 
 ############################
 Running Course Discussions
 ############################
 
+.. tags:: educator, concept
+
 On an ongoing basis, the members of your :ref:`discussion
 team<Assigning_discussion_roles>` run the course discussion by adding posts
 and responses, marking answers as correct, and guiding learner messages into

diff --git a/source/educators/concepts/data/learner_data.rst b/source/educators/concepts/data/learner_data.rst
@@ -1,11 +1,11 @@
-.. :diataxis-type: concept
-
 .. _Learner Data:
 
 ############################
 Learner Data
 ############################
 
+.. tags:: educator, concept
+
 You can access data about the individuals who are enrolled in your course at
 any time after you create the course.
 

diff --git a/source/educators/concepts/exercise_tools/OpenResponseAssessments.rst b/source/educators/concepts/exercise_tools/OpenResponseAssessments.rst
@@ -1,10 +1,11 @@
-.. :diataxis-type: concept
 .. _Open Response Assessments:
 
 ###########################################
 Introduction to Open Response Assessments
 ###########################################
 
+.. tags:: educator, concept
+
 In open response assessments (ORA), learners submit essay responses and then go
 through a series of assessment steps (such as peer assessment and self
 assessment) to complete the assignment.

diff --git a/source/educators/concepts/exercise_tools/create_exercises.rst b/source/educators/concepts/exercise_tools/create_exercises.rst
@@ -1,10 +1,11 @@
-.. :diataxis-type: concept
 .. _Create Exercises:
 
 ##############################
 Problems, Exercises, and Tools
 ##############################
 
+.. tags:: educator, concept
+
 You can add a wide variety of different types of problems, exercises, and
 tools to your course outline. By default, a core set of :ref:`problem
 types<Working with Problem Components>` is available in Studio for you to