Skip to content

Commit

Permalink
Complete Migration of Legacy Docs to Open edX Docs (#589)
Browse files Browse the repository at this point in the history
* Assimilate Legacy edX docs 1_general_information into Open edX docs

* Assimilate Legacy edX docs 2_getting_started into Open edX docs

* Assimilate Legacy edX docs 3_dashboard_profile into Open edX docs

* Remove reference to tags

* Assimilate Legacy edX docs 4_reaching_learners into Open edX docs

* Assimilate Legacy edX docs 5_accessibility into Open edX docs

* [WIP] Assimilate Legacy edx docs 6_setup_course into Open edX docs

* Assimilate Legacy edX docs 20_glossary into Open edX docs

* Assimilate Legacy edX docs 19_rerun_course into Open edX Docs

* Assimilate Legacy edX docs 18_student_progress into Open edX Docs

* Assimilate Legacy edX docs 18_student_progress into Open edX Docs pt. 2

* Assimilate Legacy edX docs 17_manage_discussions into Open edX Docs

* Assimilate Legacy edX docs 16_manage_live_course and 15_releasing_course into Open edX docs

* Assimilate Legacy edX docs 14_grading into Open edX Docs

* Assimilate Legacy edX docs 13_proctored_exams into Open edX Docs

* Assimilate Legacy edX docs 6_set_up_course into Open edX docs
Assimilate Legacy edX docs 7_developing_courses into Open edX docs

* Assimilate Legacy edX docs 6_set_up_course and 7_developing_course into Open edX docs

* Assimilate Legacy edX docs 8_course_components into Open edX Docs (WIP)

* Assimilate Legacy edX docs 8_course_components work in progress

* Assimilate Legacy edX docs 8_course_components images work in progress

* Assimilate Legacy edX docs 6_set_up_course and 7_developing_course into Open edX docs Part 2

* Assimilate legacy edx Docs 12_course_features into Open edX Docs

* Assimilate legacy edx Docs 12_course_features into Open edX Docs WIP

* Revert change to Makefile that was specific to debugging

* Move remaining WIP Migration docs to an orphan page

* Assimilate legacy edx Docs 8_course_components into Open edX Docs

* Assimilate legacy edx Docs 9_creating_and_adding_video_content into Open edX Docs

* Assimilate legacy edX Docs 12_course_features into Open EdX Docs

* Assimilate legacy edX Docs 11_course_assets into Open EdX Docs

* Assimilate legacy edX Docs 10_exercise_tools into Open EdX Docs WIP

* Assimilate legacy edX Docs 10_exercise_tools into Open EdX Docs WIP

* Remove unused images and fix remaining image references

* Fix broken references

* Consolidate links to one file and remove unused links

* Revert --keep-going flag in Makefile (used for debugging)

* Resolve additional conflicts

---------

Co-authored-by: Shannon Rushe <[email protected]>
  • Loading branch information
jswope00 and srushe1 authored Oct 17, 2024
1 parent 4c3c4d4 commit a195371
Show file tree
Hide file tree
Showing 412 changed files with 10,708 additions and 12,461 deletions.
39 changes: 39 additions & 0 deletions image_map.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import os
import subprocess

def grep_for_filenames(source_dir, search_dir):
# Loop through each file in the source directory
for root, dirs, files in os.walk(source_dir):
for file_name in files:
# Define the full path to the current file
file_path = os.path.join(root, file_name)

# Get the base file name (without path) to search for it
base_file_name = os.path.basename(file_path)

print(f"Searching for '{base_file_name}' in {search_dir}...")

# Use subprocess to call grep recursively in the target directory
result = subprocess.run(
["grep", "-rl", base_file_name, search_dir],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
text=True
)

if result.stdout:
print(f"Found occurrences of '{base_file_name}':\n{result.stdout}")
else:
print(f"No occurrences found for '{base_file_name}'")

if result.stderr:
print(f"Error: {result.stderr}")


# Define the source directory (containing file names) and search directory
source_dir = "source/educators/migration_wip/images"
search_dir = "source/"

# Call the function
grep_for_filenames(source_dir, search_dir)

File renamed without changes
2 changes: 0 additions & 2 deletions source/community/how-tos/receive_announcements_by_email.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,3 @@ subscribe to announcements on one of the edX portal sites.

You will now receive email messages when new announcements of the types you
selected are posted.

.. include:: ../../educators/migration_wip/links/links.rst
2 changes: 0 additions & 2 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,6 @@
"default_image_width": "60%",
}

# 'migration_wip' links.rst added while migration is underway. Should be removed after migration.
rst_epilog = """
.. raw:: html
Expand All @@ -145,7 +144,6 @@
.. include:: /substitutions.txt
.. include:: /links.txt
.. include:: /educators/migration_wip/links/links.rst
"""

Expand Down
2 changes: 0 additions & 2 deletions source/developers/how-tos/add-sphinx-docs-to-a-repo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ Assumptions

* You are familiar with `basic python development`_ (pip, virtualenvs, etc.)

.. _make: https://www.gnu.org/software/make/manual/html_node/index.html

.. _basic python development: https://docs.python.org/3/tutorial/index.html

Steps
Expand Down
1 change: 0 additions & 1 deletion source/developers/how-tos/get-ready-for-frontend-dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,3 @@ Steps

:doc:`/developers/concepts/platform_overview`

.. _Devstack: https://edx.readthedocs.io/projects/open-edx-devstack/en/latest/
4 changes: 1 addition & 3 deletions source/developers/how-tos/get-ready-for-python-dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Once you have done this, any calls to ``python``, ``pip``, or other Python execu

.. note::

Many developers use wrapper scripts (or write their own using shell aliases). One commonly used tool is `virtualenvwrapper <https://virtualenvwrapper.readthedocs.io/en/stable/>`_, which manages the virtualenv directories outside of repositories; this avoids several issues with git and other tools being able to see the virtualenv, but will require explicitly naming each virtualenv.
Many developers use wrapper scripts (or write their own using shell aliases). One commonly used tool is `virtualenvwrapper`_, which manages the virtualenv directories outside of repositories; this avoids several issues with git and other tools being able to see the virtualenv, but will require explicitly naming each virtualenv.

Working on a Repo
=================
Expand Down Expand Up @@ -80,5 +80,3 @@ Working on a Repo
#. Run ``make test`` one more time and commit your changes with ``git add`` and ``git commit``. Follow the `conventional commits`_ documentation. Make sure your commit message is informative and describes why the change is being made. While the first line of the message should be terse, the body of the message has plenty of room for details.
#. Push your changes to GitHub with ``git push``.
#. In GitHub, open a pull request (PR). In the PR description, include anything that could help reviewers understand and test your change.

.. _conventional commits: https://open-edx-proposals.readthedocs.io/en/latest/best-practices/oep-0051-bp-conventional-commits.html
1 change: 0 additions & 1 deletion source/developers/how-tos/ongoing-maintainers-tasks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ Here are a few rules-of-thumb to keep in mind:
reviewed by somebody other than the submitter. And if the change is
user-facing, it must necessarily undergo the public `Product Review Process`_.

.. _Product Review Process: https://openedx.atlassian.net/wiki/spaces/COMM/pages/3875962884/How+to+submit+an+open+source+contribution+for+Product+Review

.. important::

Expand Down
1 change: 0 additions & 1 deletion source/developers/references/developer_guide/analytics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -310,4 +310,3 @@ continue to be supported.

.. _event-tracking: https://github.com/openedx/event-tracking
.. _event-tracking documentation: http://event-tracking.readthedocs.io/en/latest/overview.html#event-tracking
.. _Segment: https://segment.com/
Loading

0 comments on commit a195371

Please sign in to comment.