docs: add tutor compatibility notes #1122
Open
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
MaferMazu
force-pushed
the
mfmz/docs-tutor-version
branch
3 times, most recently
from
804a395
to
35d8f87
Compare
|
I also tried this: |
|
@kdmccormick @regisb @sarina, could you help me review this PR? |
MaferMazu
force-pushed
the
mfmz/docs-tutor-version
branch
from
35d8f87
to
0fd8bc0
Compare
regisb
reviewed
Sep 19, 2024
changelog.d/20240918_121327_maria.magallanes_docs_tutor_version.md
Outdated
Show resolved
Hide resolved
MaferMazu
force-pushed
the
mfmz/docs-tutor-version
branch
from
0fd8bc0
to
a5468c0
Compare
|
I applied the feedback. If you have more feedback, please let me know. Screenshot |
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.
Description
This PR adds the compatibility notes in the README.
Also, it adds information on the initial page for documentation and is referenced on the installation process page.
Context: Sometimes, we need another Open edX release different from the latest. So, by adding this documentation, we can guide what tutor version the person should install for different Open edX releases.
How to test
virtualenv venvsource venv/bin/activatepip install -r requirements/docs.txtcd docs/make watchdocs/_build/html/index.htmland see the Compatibility Notes, and review thedocs/_build/html/install.htmlto check the download python package section.Screenshots
Index page:
Install page:
