docs: update README for 2U fork #25
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
robrap
commented
Jul 16, 2024
This was referenced Jul 16, 2024
timmc-edx
reviewed
Jul 16, 2024
|
|
||
| .. _Getting Started guide: https://edx.readthedocs.io/projects/open-edx-devstack/en/latest/getting_started.html | ||
| .. _Getting Started guide: https://github.com/edx/devstack/blob/master/docs/getting_started.rst |
There was a problem hiding this comment.
What's the reason for switching these URLs from the rendered docs to the source? Do we no longer have the ability to push to edx.readthedocs.io?
There was a problem hiding this comment.
Yes. That is for the Open edX version, which they don't plan on retiring, but they are going to put up a banner that points to this file. We could publish to read the docs at some point again, but that is future work that I am not taking on, so this README update just reflects the current reality.
There was a problem hiding this comment.
Here is the ticket for publishing to Read the Docs again: edx/edx-arch-experiments#578
timmc-edx
approved these changes
Jul 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've completed each of the following or determined they are not applicable: