Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update Python 3.11 docs and more #20

Merged
merged 6 commits into from
Jul 16, 2024

Conversation

robrap
Copy link

@robrap robrap commented Jun 24, 2024

A variety of devstack doc updates, including:

  • docs: manual upgrade for Python 3.11
  • docs: add note for Demo course is empty in studio
  • fix: update readthedocs repo url
  • fix: git openedx to edx repo docs

See edx/edx-arch-experiments#578 for future work related to updating our docs.


I've completed each of the following or determined they are not applicable:

  • Made a plan to communicate any major developer interface changes (or N/A)


You can point to the 2U fork of devstack with the following command::

% git remote set-url origin ssh://[email protected]/edx/devstack
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[inform] This is what I did locally, but my PR still got set up against openedx-unsupported at first, so there are other local changes I probably need to fix master, right?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a separate thing we'll need to fix. GitHub knows that we forked edx/devstack from openedx-unsupported/devstack (either before or after the move from openedx) and so it assumes we want to contribute PRs to the upstream. I don't know if there's a way to change that behavior other than asking GitHub to unlink the repo from that "network".

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a bummer.

@robrap
Copy link
Author

robrap commented Jun 24, 2024

I added edx/edx-arch-experiments#578 (comment) to take note of other things I found. I also wonder if I should back out any non-RST changes from this PR so that provisioning is not required?

@timmc-edx
Copy link
Member

I found the issue that make docs was failing on and added a suggestion.

But you could also remove the make docs from the end of the provisioning workflow (I don't think that was ever really needed there!) and add docs/ to the paths-ignore of that workflow as well, if you wanted to do some clean there as well.

robrap added 4 commits July 16, 2024 10:56
This is to allow a local devstack to continue to work
post this Python 3.11 update:
See openedx/edx-platform#34982
This probably won't fix readthedocs for us, but
may get us one step closer.

See edx/edx-arch-experiments#578
Provide some fixes for working with the edx fork of devstack.

Also see edx/edx-arch-experiments#578
@robrap robrap force-pushed the robrap/update-docs-python-311-plus branch from b69920a to 04d614b Compare July 16, 2024 14:57
@robrap robrap force-pushed the robrap/update-docs-python-311-plus branch from 04d614b to 99f1d2c Compare July 16, 2024 15:00
@robrap robrap merged commit ee5ccaa into master Jul 16, 2024
12 checks passed
@robrap robrap deleted the robrap/update-docs-python-311-plus branch July 16, 2024 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants