Merge pull request #20 from edx/robrap/update-docs-python-311-plus

docs: update Python 3.11 docs and more

.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: [email protected]
            from: github-actions <[email protected]>
            body: Devstack provisioning tests in ${{github.repository}} are back to normal for ${{matrix.services}}
-
-      - name: docs
-        run:  make docs

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,

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
 **************************************************

docs/troubleshoot_general_tips.rst

@@ -169,25 +169,38 @@ 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://[email protected]/openedx/devstack (fetch)
+    origin	ssh://[email protected]/openedx/devstack (push)
+
+You can point to the 2U fork of devstack with the following command::
+
+    % git remote set-url origin ssh://[email protected]/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*
 (i.e., you have pushed or otherwise saved your work elsewhere)
 then you can always delete the repository and start over again::
 
     rm -rf ./<repository>
-    git clone [email protected]:openedx/<repository>
+    git clone [email protected]:edx/<repository>
 
 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
 --------------------------------
 
@@ -224,6 +237,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.