To view an engineer's work in the Studio or LMS UI, ask that engineer for access to the latest sandbox, or create a sandbox based on the engineer's PR on the edx-platform repo.
Additionally, before each edx-platform release, the "stage" studio and LMS sites are refreshed so that all the changes that will be in the release are visible. This gives us an opportunity to take screen shots and otherwise sanity check before (or immediately after) a platform release goes out.
To access Stage, go to https://studio.stage.edx.org for Studio, or https://stage.edx.org for the LMS. If you don't have a Stage username and password, see edx.org, Edge, and Stage.
All projects must generate HTML output without warnings or errors. To make sure no errors are present, run tests on the specific guide you're working on, and then run tests on all the guides.
This procedure will build a single guide based on the files on your local machine. It can help sanity check, but you must also test all guides using the "Test all guides" process below.
build
subdirectory, delete it.course_authors.
make html
build
subdirectory in step 1, recently introduced problems might not be detected.)NOTE: If the file you've changed is shared by multiple guides (files in the shared directory), you need to build and test all of the impacted guides. To locally build all guides that have directories under en_us, cd
to the en_us directory and run make html
.
Ensure there are no build warnings or errors in any guides.
edx-documentation
directory../run_tests.sh
About once every six months, run the linkchecker tool in Sphinx to make sure all the links work.
cd
to the en_us
directory.make linkchecker
For more information, see the final comment on documentation PR 1267.