From 09acf8be9984175c094a8e9c0c3c1bc4c4856420 Mon Sep 17 00:00:00 2001 From: Robert Raposa Date: Mon, 24 Jun 2024 15:21:55 -0400 Subject: [PATCH 1/6] docs: manual upgrade for Python 3.11 This is to allow a local devstack to continue to work post this Python 3.11 update: See https://github.com/openedx/edx-platform/pull/34982 --- docs/manual_upgrades.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/manual_upgrades.rst b/docs/manual_upgrades.rst index 31b6962796..a2bf28c67a 100644 --- a/docs/manual_upgrades.rst +++ b/docs/manual_upgrades.rst @@ -7,6 +7,16 @@ Please add new instructions to the top, include a date, and make a post in the ` (If you just need to update your devstack to the latest version of everything, see :doc:`updating_devstack`.) +2024-06-13 - Upgrade from Python 3.8 to 3.11 +******************************************** + +As part of the Python upgrade in edx-platform, some manual steps are required for the Python 3.11 upgrade to allow you to pull Python dependencies. + +1. Take latest ``git pull`` of ``devstack`` + +2. Take the latest pull of images:: + + make dev.pull.without-deps.lms+cms 2024-04-29 - Moved Open edX analytics repositories ************************************************** From ccf9819b3bef99eaf7fd893434e0b1179e9545f1 Mon Sep 17 00:00:00 2001 From: Robert Raposa Date: Mon, 24 Jun 2024 16:05:54 -0400 Subject: [PATCH 2/6] docs: add note for Demo course is empty in studio Add update around ticket URL. --- docs/troubleshoot_general_tips.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/troubleshoot_general_tips.rst b/docs/troubleshoot_general_tips.rst index 84de18a559..eb8055378f 100644 --- a/docs/troubleshoot_general_tips.rst +++ b/docs/troubleshoot_general_tips.rst @@ -224,6 +224,8 @@ To fix this locally, simply add a new subsection and publish. The act of publish See https://github.com/openedx/devstack/issues/1073 for the GitHub issue tracking this bug. +Update as of 2023-08-03: The issue was moved to https://2u-internal.atlassian.net/browse/TNL-11478, but closed as "Won't Do" due to business priorities. + CORS error from login_refresh in MFE ------------------------------------ If you see "Access to XMLHttpRequest at 'http://localhost:18000/login_refresh' from origin 'http://localhost:2000' has been blocked by CORS policy: Request header field x-xsrf-token is not allowed by Access-Control-Allow-Headers in preflight response" it usually means you don't have a valid session. From a6ee9ae83b23a72366def89a45f0cb50022bfc0f Mon Sep 17 00:00:00 2001 From: Robert Raposa Date: Mon, 24 Jun 2024 16:07:25 -0400 Subject: [PATCH 3/6] fix: update readthedocs repo url This probably won't fix readthedocs for us, but may get us one step closer. See https://github.com/edx/edx-arch-experiments/issues/578 --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 5feb31a61f..8840e8b82d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -165,7 +165,7 @@ # documentation. # html_theme_options = { - "repository_url": "https://github.com/openedx/devstack", + "repository_url": "https://github.com/edx/devstack", "repository_branch": "master", "path_to_docs": "docs/", "home_page_in_toc": True, From 81e923ce804ef700751bdcf7e4d35a90123bd8a2 Mon Sep 17 00:00:00 2001 From: Robert Raposa Date: Mon, 24 Jun 2024 16:19:53 -0400 Subject: [PATCH 4/6] fix: git openedx to edx repo docs Provide some fixes for working with the edx fork of devstack. Also see https://github.com/edx/edx-arch-experiments/issues/578 --- docs/troubleshoot_general_tips.rst | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/troubleshoot_general_tips.rst b/docs/troubleshoot_general_tips.rst index eb8055378f..90c4def3c7 100644 --- a/docs/troubleshoot_general_tips.rst +++ b/docs/troubleshoot_general_tips.rst @@ -169,11 +169,23 @@ commands from within the repository:: General git troubleshooting --------------------------- -``git`` is powerful but complex; you may occasionally find your respository in a +``git`` is powerful but complex; you may occasionally find your repository in a confusing state. This problem isn't devstack-specific. -If you find yourself stuck, folks in the edX-internal or Open edX Slack workspaces may -be able to give you a hand. +If you find yourself stuck, folks in the 2U Slack workspace may be able to give +you a hand. + +Ensure you are not still pointing to the old openedx repo. If you see openedx when running the following command:: + + % git remote -v + origin ssh://git@github.com/openedx/devstack (fetch) + origin ssh://git@github.com/openedx/devstack (push) + +You can point to the 2U fork of devstack with the following command:: + + % git remote set-url origin ssh://git@github.com/edx/devstack + +Note: You don't need to use ``ssh`` if you were using ``https` instead. Alternatively, if you are at a roadblock and *don't care about any changes you've made to your local copy of the repository* @@ -181,13 +193,14 @@ Alternatively, if you are at a roadblock and then you can always delete the repository and start over again:: rm -rf ./ - git clone git@github.com:openedx/ + git clone git@github.com:edx/ Finally, if you regularly find yourself mystified by git, consider reading through `Understanding Git Conceptually`_. It explains core Git principles in way that makes it easier to use the simpler ``git`` commands more effectively and easier to use the more complicated ``git`` commands when you have to. + Problems with shared directories -------------------------------- From d1d5178c49101285194276f98704b5c93dd45bde Mon Sep 17 00:00:00 2001 From: Robert Raposa Date: Tue, 16 Jul 2024 10:59:21 -0400 Subject: [PATCH 5/6] fixup! fix quality issue --- docs/troubleshoot_general_tips.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/troubleshoot_general_tips.rst b/docs/troubleshoot_general_tips.rst index 90c4def3c7..ef24bb03ca 100644 --- a/docs/troubleshoot_general_tips.rst +++ b/docs/troubleshoot_general_tips.rst @@ -185,7 +185,7 @@ You can point to the 2U fork of devstack with the following command:: % git remote set-url origin ssh://git@github.com/edx/devstack -Note: You don't need to use ``ssh`` if you were using ``https` instead. +Note: You don't need to use ``ssh`` if you were using ``https`` instead. Alternatively, if you are at a roadblock and *don't care about any changes you've made to your local copy of the repository* From 99f1d2c00e33d4c94f988d3289533c94dd946c80 Mon Sep 17 00:00:00 2001 From: Robert Raposa Date: Tue, 16 Jul 2024 10:56:14 -0400 Subject: [PATCH 6/6] feat: remove docs from provisioning tests --- .github/workflows/provisioning-tests.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/provisioning-tests.yml b/.github/workflows/provisioning-tests.yml index 02176fc420..5af1594975 100644 --- a/.github/workflows/provisioning-tests.yml +++ b/.github/workflows/provisioning-tests.yml @@ -7,9 +7,11 @@ on: branches: [master] paths-ignore: - '**.rst' + - 'docs/' pull_request: paths-ignore: - '**.rst' + - 'docs/' schedule: # run at 7:30 am M-F - cron: '30 11 * * 1-5' @@ -108,6 +110,3 @@ jobs: to: devstack-provisioning-tests@2u-internal.opsgenie.net from: github-actions body: Devstack provisioning tests in ${{github.repository}} are back to normal for ${{matrix.services}} - - - name: docs - run: make docs